Skip to content

Commit

Permalink
Merge pull request github#34804 from github/repo-sync
Browse files Browse the repository at this point in the history
Repo sync
  • Loading branch information
docs-bot authored Oct 1, 2024
2 parents 5c299a9 + 06458da commit 3772a69
Show file tree
Hide file tree
Showing 33 changed files with 393 additions and 36 deletions.
Binary file added assets/images/help/issues/issue-add-type.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/help/issues/issue-edit-title.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/help/issues/issue-type-edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/help/issues/sub-issue-expand.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/help/issues/sub-issue-parent.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions content/get-started/accessibility/keyboard-shortcuts.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,11 @@ If you view a code file in a repository using the **Code** view and click on any
|<kbd>Shift</kbd> and click | When creating an issue from a task list, open the new issue form in a new tab by holding <kbd>Shift</kbd> and clicking the {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. For more information, see "[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists)." |
|<kbd>Command</kbd> and click (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd> and click (Windows/Linux) | When creating an issue from a task list, open the new issue form in the new window by holding <kbd>Command</kbd> or <kbd>Ctrl</kbd>+<kbd>Shift</kbd> and clicking the {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. For more information, see "[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists)." |
| {% endif %} |
| {% ifversion sub-issues %} |
|<kbd>Option</kbd>+<kbd>Shift</kbd>+<kbd>c</kbd> (Mac) or </br> <kbd>Alt</kbd>+<kbd>Shift</kbd>+<kbd>c</kbd> (Windows/Linux) | Create a new sub-issue. See "[AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/adding-sub-issues)." |
|<kbd>Option</kbd>, <kbd>Shift</kbd>+<kbd>a</kbd> (Mac) or </br> <kbd>Alt</kbd>+<kbd>Shift</kbd>+<kbd>a</kbd> (Windows/Linux) | Add an existing issue as sub-issue. See "[AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/adding-sub-issues)." |
|<kbd>Option</kbd>+<kbd>Shift</kbd>+<kbd>p</kbd> (Mac) or </br> <kbd>Alt</kbd>+<kbd>Shift</kbd>+<kbd>p</kbd> (Windows/Linux) | Edit parent issue. |
| {% endif %} |

## "Files changed" tab in pull requests

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -208,3 +208,31 @@ You can also use a <code>&ast;</code> as a wildcard.
| <code>field:&ast;<em>TEXT</em> | **label:&ast;support** will show items with a label that ends with "support."

{% endif %}

{% ifversion issue-types %}

## Filtering by issue type

If your organization uses issue types, you can filter for particular types.

{% data reusables.issues.release-stage %}

| Qualifier | Example
| ---------- | -------------
| <code>type:&quot;<em>ISSUE TYPE</em>&quot; | **type:&quot;bug&quot;** will show issues with the "bug" type.

{% endif %}

{% ifversion sub-issues %}

## Filtering by parent issue

You can filter your sub-issues by their parent issue.

{% data reusables.issues.release-stage %}

| Qualifier | Example
| ---------- | -------------
| <code>parent-issue:<em>OWNER/REPO#ISSUE NUMBER</em></code> | **parent-issue:octocat/game#4** will show issues with issue #4 in octocat/game as their parent issue.

{% endif %}
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: About parent issue and sub-issue progress fields
shortTitle: About sub-issue fields
intro: 'You can show an issue''s parent issue and view sub-issue progress in your projects.'
versions:
feature: sub-issues
type: tutorial
topics:
- Projects
---

If your organization uses sub-issues, you can enable the "Parent issue" and "Sub-issue progress" fields on your projects to see the relationships between your issues and the progress made on those issues.

The "Parent issue" field can be used to group items, allowing you to create views that break down your work using the sub-issue hierarchies you have created. For more about grouping views, see "[AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view#grouping-by-field-values-in-table-layout)."

You can also filter by the "Parent issue" field to only display items that are sub-issues of a particular issue. You can start by typing "parent-issue" and then selecting an issue from the list. Or, if you know the repository and issue number, you can type the filter in full:

```text
parent-issue:"<OWNER>/<REPO>#<ISSUE NUMBER>"
```

To use the filter, replace `<OWNER>` with the repository owner, `<REPO>` with the repository name, and `<ISSUE NUMBER>` with the issue number. See "[AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects)."

## Enabling the Parent issue field

You can enable the "Parent issue" field to see which parent issues the issues in your project belong to.

1. In table view, in the rightmost field header, click {% octicon "plus" aria-label="the plus icon" %}.

![Screenshot of a project. The "Add field" button, indicated by a plus icon, is highlighted with an orange outline.](/assets/images/help/projects-v2/new-field-button.png)

1. Under "Hidden fields", click **Parent issue**.

## Enabling the Sub-issue progress

You can enable the "Sub-issue progress" field to see how many sub-issues have been completed.

1. In table view, in the rightmost field header, click {% octicon "plus" aria-label="the plus icon" %}.

![Screenshot of a project. The "Add field" button, indicated by a plus icon, is highlighted with an orange outline.](/assets/images/help/projects-v2/new-field-button.png)

1. Under "Hidden fields", click **Sub-issue progress**.
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ children:
- /about-date-fields
- /about-single-select-fields
- /about-iteration-fields
- /about-parent-issue-and-sub-issue-progress-fields
- /renaming-custom-fields
- /deleting-custom-fields
allowTitleToDifferFromFilename: true
Expand Down
39 changes: 20 additions & 19 deletions content/issues/tracking-your-work-with-issues/about-issues.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: About issues
intro: 'Use {% data variables.product.prodname_github_issues %} to track ideas, feedback, tasks, or bugs for work on {% data variables.product.company_short %}.'
intro: 'Learn how you can use {% data variables.product.prodname_github_issues %} to track ideas, feedback, tasks, or bugs.'
redirect_from:
- /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/about-issues
- /articles/creating-issues
Expand All @@ -16,46 +16,47 @@ topics:
- Issues
- Project management
---
## About issues

{% data variables.product.prodname_github_issues %} are items you can create in a repository to plan, discuss and track work.
You can create issues in your repository to plan, discuss, and track work. Issues are quick to create, flexible, and can be used in many ways. Issues can track bug reports, new features and ideas, and anything else you need to write down or discuss with your team. {% ifversion sub-issues %}You can also break your work down further by adding sub-issues and easily browse the full hierarchy of work to be done.{% endif %}

Issues are simple to create and flexible to suit a variety of scenarios. You can use issues to track work, give or receive feedback, collaborate on ideas or tasks, and efficiently communicate with others.
Issues can be created in a variety of ways, so you can choose the most convenient method for your workflow. For example, you can create an issue from a repository,{% ifversion sub-issues %} while adding sub-issues,{% endif %} convert a comment in an issue or pull request, create an issue from a specific line of code, or via a URL query. You can also create an issue from your platform of choice: through the web UI, {% data variables.product.prodname_desktop %}, {% data variables.product.prodname_cli %}, GraphQL and REST APIs, or {% data variables.product.prodname_mobile %}. See "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)."

### Integrated with {% data variables.product.company_short %}
{% ifversion sub-issues %}

Issues let you track your work on {% data variables.product.company_short %}. When you mention an issue in another issue or pull request, the issue's timeline reflects the cross-reference so that you can keep track of related work. To indicate that work is in progress, you can link an issue to a pull request. When the pull request merges, the linked issue automatically closes.
## About sub-issues

For more information on keywords, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)."
{% data reusables.issues.release-stage %}

### Quickly create issues
{% data reusables.issues.about-sub-issues %} See "[AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/adding-sub-issues)" and "[AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/browsing-sub-issues)."

Issues can be created in a variety of ways, so you can choose the most convenient method for your workflow. For example, you can create an issue from a repository,{% ifversion fpt or ghec %} an item in a task list,{% endif %} a note in a project, a comment in an issue or pull request, a specific line of code, or a URL query. You can also create an issue from your platform of choice: through the web UI, {% data variables.product.prodname_desktop %}, {% data variables.product.prodname_cli %}, GraphQL and REST APIs, or {% data variables.product.prodname_mobile %}. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)."
{% endif %}

### Track work
## About integration with {% data variables.product.github %}

You can organize and prioritize issues with projects. {% ifversion fpt or ghec %}To track issues as part of a larger issue, you can use task lists.{% endif %} To categorize related issues, you can use labels and milestones.
Issues integrate with your work all across {% data variables.product.github %}. Mentioning an issue in another issue or pull request will create references between them and using keywords, like `fixes:`, in your pull requests will automatically close the associated issues. See "[AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue)."

For more information about projects, see {% ifversion projects-v2 %}"[AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." {% else %}"[AUTOTITLE](/issues/organizing-your-work-with-project-boards)."{% endif %} {% ifversion fpt or ghec %}For more information about task lists, see "[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists)." {% endif %}For more information about labels and milestones, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work)."
{% data variables.projects.projects_v2_caps %} is strongly integrated with issues. All your issue metadata is available in your projects, allowing you to create views and filters to represent your work. See "[AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)."

### Stay up to date
## Staying up to date

To stay updated on the most recent comments in an issue, you can subscribe to an issue to receive notifications about the latest comments. To quickly find links to recently updated issues you're subscribed to, visit your dashboard. For more information, see "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)" and "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/about-your-personal-dashboard)."

### Community management
You can assign yourself and teammates to issues to make it clear who is working on an issue and also make it easier for you to locate your issues. See "[AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/assigning-issues-and-pull-requests-to-other-github-users)" and "[AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/viewing-all-of-your-issues-and-pull-requests)."

## Community management

To help contributors open meaningful issues that provide the information that you need, you can use {% ifversion fpt or ghec %}issue forms and {% endif %}issue templates. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)."
To help contributors open meaningful issues that provide the information that you need, you can use {% ifversion fpt or ghec %}issue forms and {% endif %}issue templates. See "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests)."

{% ifversion fpt or ghec %}To maintain a healthy community, you can report comments that violate {% data variables.product.prodname_dotcom %}'s [Community Guidelines](/free-pro-team@latest/site-policy/github-terms/github-community-guidelines). For more information, see "[AUTOTITLE](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)."{% endif %}
{% ifversion fpt or ghec %}To maintain a healthy community, you can report comments that violate {% data variables.product.github %}'s [Community Guidelines](/free-pro-team@latest/site-policy/github-terms/github-community-guidelines). See "[AUTOTITLE](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)."{% endif %}

### Efficient communication
## Efficient communication

You can @mention collaborators who have access to your repository in an issue to draw their attention to a comment. To link related issues in the same repository, you can type `#` followed by part of the issue title and then clicking the issue that you want to link. To communicate responsibility, you can assign issues. If you find yourself frequently typing the same comment, you can use saved replies.
{% ifversion fpt or ghec %} For more information, see "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)" and "[AUTOTITLE](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users)."
{% ifversion fpt or ghec %} See "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)" and "[AUTOTITLE](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users)."
{% endif %}
{% ifversion discussions %}

### Comparing issues and discussions
## Comparing issues and discussions

Some conversations are more suitable for {% data variables.product.prodname_discussions %}. {% data reusables.discussions.you-can-use-discussions %} For guidance on when to use an issue or a discussion, see "[AUTOTITLE](/get-started/using-github/communicating-on-github)."

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ topics:
children:
- /quickstart
- /planning-and-tracking-work-for-your-team-or-project
- /managing-issue-types-in-an-organization
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Managing issue types in an organization
intro: 'Learn about issue types and how to manage them in your organization.'
versions:
feature: 'issue-types'
type: overview
topics:
- Project management
shortTitle: 'Managing issue types'
permissions: 'Organization owners can modify issue types.'
---

{% data reusables.issues.release-stage %}

You can use issue types to classify and manage different types of issues across your organization. You can create up to ten issue types that your organization members can apply to issues, making it easier for you and your members to find issues and plan work.

Default issue types are included in every organization, but these can edited, disabled, or deleted. The default types are task, bug, and feature.

When you add an issue type to an issue, the type will be shown on any lists of issues and in the issues themselves. You can filter and search by issue type and use issue types when creating filters and views in your projects. See "[AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests#filtering-by-issue-type)" and "[AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects#filtering-by-issue-type)."

## Adding an issue type

{% data reusables.issues.access-issue-types-settings %}
1. On the right side of the page, click **Create new type**.
1. Under "Type name", type the name of your new issue type.
1. Under "Description", to help other people understand the purpose of your new issue type, type a description.
1. Under "Color", click on the color you would like for the new issue type.
1. Optionally, to stop the new issue type being available in public repositories, select **Private repositories only**.
1. Click **Create**.

## Making changes to issue types

You can change the name, description, color, and public repository visibility of your issue types.

You can also choose to disable or delete an issue type. If you disable an issue type, it will not be shown and it won't be possible to set an issue to that type, but if you later decide to enable the issue type, it will be displayed again on any issues previously set to the issue type. If you delete an issue type, it is permanently removed.

{% data reusables.issues.access-issue-types-settings %}
1. To the right of the issue type you want to make changes to, click {% octicon "kebab-horizontal" aria-label="open type options" %}.

![Screenshot of the issue types settings page for an organization. The "open type options" button is highlighted with an orange rectangle.](/assets/images/help/issues/issue-type-edit.png)

1. In the menu, click **Edit** and make your changes.
* To make changes to the type name, description, color, and if the issue type should only appear for private repositories. Then click **Save**.
* To disable or delete the issue type, in the "Danger zone", click **Disable** or **Delete** and follow the prompts.
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,16 @@ Below we have added a task list to our Project Octocat issue, breaking it down i

![Screenshot of an issue called "Front-end work for Project Octocat." The issue body contains a task list, with a checkbox preceding each issue link.](/assets/images/help/issues/quickstart-add-task-list-to-issue.png)

{% ifversion sub-issues %}

### Breaking down your work with sub-issues

{% data reusables.issues.release-stage %}

{% data reusables.issues.about-sub-issues %} See "[AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/adding-sub-issues)" and "[AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/browsing-sub-issues)."

{% endif %}

## Making decisions as a team

You can use issues and discussions to communicate and make decisions as a team on planned improvements or priorities for your project. Issues are useful when you create them for discussion of specific details, such as bug or performance reports, planning for the next quarter, or design for a new initiative. Discussions are useful for open-ended brainstorming or feedback, outside the codebase and across repositories. For more information, see "[AUTOTITLE](/get-started/using-github/communicating-on-github#which-discussion-tool-should-i-use)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,12 @@ You can use issues for a wide range of purposes. For example:
* Planning tasks
* Reporting bugs

{% ifversion sub-issues %}

To break your issue down into more manageable tasks, you can add multiple levels of sub-issues. See "[AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/adding-sub-issues)."

{% endif %}

Here are some helpful resources for taking your next steps with {% data variables.product.prodname_github_issues %}:

* To learn more about issues, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/about-issues)."
Expand Down
8 changes: 0 additions & 8 deletions content/issues/tracking-your-work-with-issues/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,4 @@ children:
redirect_from:
- /issues/tracking-your-work-with-issues/creating-issues
- /issues/tracking-your-work-with-issues/managing-issues
- /early-access/issues/about-tasklists
- /issues/tracking-your-work-with-issues/about-tasklists
- /issues/managing-your-tasks-with-tasklists/about-tasklists
- /issues/managing-your-tasks-with-tasklists/creating-a-tasklist
- /issues/managing-your-tasks-with-tasklists
- /issues/managing-your-tasks-with-tasklists/managing-tasks-in-a-tasklist
- /issues/managing-your-tasks-with-tasklists/quickstart-for-tasklists
- /issues/managing-your-tasks-with-tasklists/using-projects-and-tasklists
---
Loading

0 comments on commit 3772a69

Please sign in to comment.