1
0
mirror of synced 2025-12-19 18:10:59 -05:00

Updating Quickstart, Best practices, and general Issues & Projects docs (#56734)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Sophie <29382425+sophietheking@users.noreply.github.com>
This commit is contained in:
Riley Broughten
2025-08-26 11:37:44 -07:00
committed by GitHub
parent b10595f8d2
commit d92ffc1e0b
27 changed files with 428 additions and 98 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 258 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 118 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 163 KiB

After

Width:  |  Height:  |  Size: 537 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 95 KiB

After

Width:  |  Height:  |  Size: 438 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 100 KiB

After

Width:  |  Height:  |  Size: 483 KiB

View File

@@ -21,7 +21,7 @@ topics:
## About tasklists ## About tasklists
> [!IMPORTANT] > [!IMPORTANT]
> Tasklists are {% data variables.release-phases.retired %}. You can read more about this on the [GitHub Blog](https://github.blog/changelog/2025-04-29-closing-down-code-scanning-alerts-tracked-in-tasklists/). > Tasklist blocks are {% data variables.release-phases.retired %}. You can read more about this on the [{% data variables.product.github %} Blog](https://github.blog/changelog/2025-02-18-github-issues-projects-february-18th-update/).
> >
> {% ifversion sub-issues %} You can use sub-issues as the replacement for tasklist blocks. Sub-issues provide a dedicated section within each issue, making it easier to track related work without relying on Markdown. For more information about sub-issues, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/adding-sub-issues). {% endif %} > {% ifversion sub-issues %} You can use sub-issues as the replacement for tasklist blocks. Sub-issues provide a dedicated section within each issue, making it easier to track related work without relying on Markdown. For more information about sub-issues, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/adding-sub-issues). {% endif %}

View File

@@ -9,17 +9,25 @@ versions:
ghes: '*' ghes: '*'
ghec: '*' ghec: '*'
includeGuides: includeGuides:
- /issues/planning-and-tracking-with-projects/automating-your-project/automating-projects-using-actions - /issues/tracking-your-work-with-issues/learning-about-issues/quickstart
- /issues/planning-and-tracking-with-projects/creating-projects/creating-a-project
- /issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view
- /issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects - /issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects
- /issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects - /issues/tracking-your-work-with-issues/learning-about-issues/planning-and-tracking-work-for-your-team-or-project
- /issues/tracking-your-work-with-issues/configuring-issues/quickstart - /issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects
- /issues/tracking-your-work-with-issues/using-issues/creating-an-issue - /issues/tracking-your-work-with-issues/using-issues/creating-an-issue
- /issues/planning-and-tracking-with-projects/creating-projects/creating-a-project
- /issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization
- /issues/tracking-your-work-with-issues/using-issues/adding-sub-issues
- /issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests - /issues/tracking-your-work-with-issues/using-issues/filtering-and-searching-issues-and-pull-requests
- /issues/tracking-your-work-with-issues/configuring-issues/planning-and-tracking-work-for-your-team-or-project
- /issues/tracking-your-work-with-issues/using-issues/viewing-all-of-your-issues-and-pull-requests - /issues/tracking-your-work-with-issues/using-issues/viewing-all-of-your-issues-and-pull-requests
- /issues/organizing-your-work-with-project-boards/managing-project-boards/configuring-automation-for-project-boards
- /issues/using-labels-and-milestones-to-track-work/managing-labels - /issues/using-labels-and-milestones-to-track-work/managing-labels
- /issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests - /issues/using-labels-and-milestones-to-track-work/creating-and-editing-milestones-for-issues-and-pull-requests
- /issues/planning-and-tracking-with-projects/understanding-fields
- /issues/planning-and-tracking-with-projects/customizing-views-in-your-project
- /issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/creating-charts
- /issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization
- /issues/planning-and-tracking-with-projects/automating-your-project/using-the-built-in-automations
- /issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects
- /issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project
- /issues/planning-and-tracking-with-projects/automating-your-project/automating-projects-using-actions
--- ---

View File

@@ -3,22 +3,22 @@ title: "{% data variables.product.prodname_github_issues %} documentation"
shortTitle: "{% data variables.product.prodname_github_issues %}" shortTitle: "{% data variables.product.prodname_github_issues %}"
intro: 'Learn how you can use {% data variables.product.prodname_github_issues %} to plan and track your work.' intro: 'Learn how you can use {% data variables.product.prodname_github_issues %} to plan and track your work.'
introLinks: introLinks:
overview: /issues/tracking-your-work-with-issues/about-issues overview: /issues/tracking-your-work-with-issues/learning-about-issues/about-issues
quickstart: /issues/tracking-your-work-with-issues/configuring-issues/quickstart quickstart: /issues/tracking-your-work-with-issues/learning-about-issues/quickstart
featuredLinks: featuredLinks:
startHere: startHere:
- /issues/tracking-your-work-with-issues/using-issues/creating-an-issue - /issues/tracking-your-work-with-issues/using-issues/creating-an-issue
- /issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects - /issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects
- /issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects - /issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects
- /communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository - /communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository
- /issues/tracking-your-work-with-issues/configuring-issues/planning-and-tracking-work-for-your-team-or-project - /issues/tracking-your-work-with-issues/learning-about-issues/planning-and-tracking-work-for-your-team-or-project
guideCards: guideCards:
- /issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view - /issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view
- /issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue - /issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue
- '{% ifversion ghes %}/issues/organizing-your-work-with-project-boards/managing-project-boards/configuring-automation-for-project-boards{% endif %}' - '{% ifversion ghes %}/issues/organizing-your-work-with-project-boards/managing-project-boards/configuring-automation-for-project-boards{% endif %}'
- /issues/planning-and-tracking-with-projects/automating-your-project/automating-projects-using-actions - /issues/planning-and-tracking-with-projects/automating-your-project/automating-projects-using-actions
popular: popular:
- /issues/tracking-your-work-with-issues/about-issues - /issues/tracking-your-work-with-issues/learning-about-issues/about-issues
- /issues/planning-and-tracking-with-projects/learning-about-projects/about-projects - /issues/planning-and-tracking-with-projects/learning-about-projects/about-projects
- /issues/planning-and-tracking-with-projects/creating-projects/creating-a-project - /issues/planning-and-tracking-with-projects/creating-projects/creating-a-project
- /communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates - /communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates

View File

@@ -1,6 +1,8 @@
--- ---
title: 'Finding your {% data variables.projects.projects_v2 %}' title: 'Finding your {% data variables.projects.projects_v2 %}'
intro: 'Learn how to locate projects in your account, organizations, repositories, and teams.' intro: 'Learn how to locate projects in your account, organizations, repositories, and teams.'
redirect_from:
- /issues/planning-and-tracking-with-projects/learning-about-projects/finding-your-projects
allowTitleToDifferFromFilename: true allowTitleToDifferFromFilename: true
versions: versions:
fpt: '*' fpt: '*'

View File

@@ -16,6 +16,8 @@ children:
- /automating-your-project - /automating-your-project
- /viewing-insights-from-your-project - /viewing-insights-from-your-project
- /managing-your-project - /managing-your-project
- /finding-your-projects
- /sharing-project-updates
allowTitleToDifferFromFilename: true allowTitleToDifferFromFilename: true
redirect_from: redirect_from:
- /issues/trying-out-the-new-projects-experience - /issues/trying-out-the-new-projects-experience

View File

@@ -15,7 +15,7 @@ topics:
## About {% data variables.product.prodname_projects_v2 %} ## About {% data variables.product.prodname_projects_v2 %}
A project is an adaptable spreadsheet, task-board, and road map that integrates with your issues and pull requests on {% data variables.product.company_short %} to help you plan and track your work effectively. You can create and customize multiple views by filtering, sorting, grouping your issues and pull requests, visualize work with configurable charts, and add custom fields to track metadata specific to your team. Rather than enforcing a specific methodology, a project provides flexible features you can customize to your teams needs and processes. A project is an adaptable table, board, and roadmap that integrates with your issues and pull requests on {% data variables.product.company_short %} to help you plan and track your work effectively at the user or organization level. You can create and customize multiple views by filtering, sorting, slicing, and grouping your issues and pull requests to manage your team backlogs and roadmaps, visualize work with configurable charts, add custom fields to track metadata specific to your team, create templates, share status updates, and automate your projects. Rather than enforcing a specific methodology, a project provides flexible features you can customize to your teams needs and processes.
To get started and create a project, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project). To learn more about the different layouts, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view). To get started and create a project, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project). To learn more about the different layouts, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view).
@@ -25,6 +25,12 @@ Your projects are built from the issues and pull requests you add, creating dire
To learn more about managing items in your project, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project) and [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project/editing-items-in-your-project). To learn more about managing items in your project, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project) and [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project/editing-items-in-your-project).
### Viewing your project from different perspectives
Quickly answer your most pressing questions by tailoring your project view to give you the information you need. You can save these views, allowing you to quickly return to them as needed and make them available to your team. Views not only let you scope down the items listed but also offer three different layout options.
You can view your project as a high-density table layout, as a kanban board, or a timeline-style roadmap. These customized views help you manage your team backlog, perform iteration planning, plan your roadmap, plan for a feature release, or triage bugs, right next to the code. For more information about the different layout options, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view).
### Adding metadata to your items ### Adding metadata to your items
You can use custom fields to add metadata to your issues, pull requests, and draft issues and build a richer view of item attributes. Youre not limited to the built-in metadata (assignee, milestone, labels, etc.) that currently exists for issues and pull requests. For example, you can add the following metadata as custom fields: You can use custom fields to add metadata to your issues, pull requests, and draft issues and build a richer view of item attributes. Youre not limited to the built-in metadata (assignee, milestone, labels, etc.) that currently exists for issues and pull requests. For example, you can add the following metadata as custom fields:
@@ -35,7 +41,7 @@ You can use custom fields to add metadata to your issues, pull requests, and dra
* A text field to add a quick note. * A text field to add a quick note.
* An iteration field to plan work week-by-week, including support for breaks. * An iteration field to plan work week-by-week, including support for breaks.
You can use up to 50 fields in a project, including built-in metadata and custom fields. To learn more about the different fields you can add to a project, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/understanding-fields). You can use up to 50 fields in a project, including built-in metadata and custom fields. To learn more about the different fields you can add to a project, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/understanding-fields) and [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project).
### Automating your projects ### Automating your projects
@@ -43,8 +49,27 @@ There are a number of ways you can add automation to your project. Built-in work
You can also use the GraphQL API and {% data variables.product.prodname_actions %} to take even greater control of your project. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects) and [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/automating-projects-using-actions). You can also use the GraphQL API and {% data variables.product.prodname_actions %} to take even greater control of your project. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects) and [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/automating-projects-using-actions).
### Viewing your project from different perspectives ### Viewing charts and insights
Quickly answer your most pressing questions by tailoring your project view to give you the information you need. You can save these views, allowing you to quickly return to them as needed and make them available to your team. Views not only let you scope down the items listed but also offer three different layout options. You can use insights for {% data variables.product.prodname_projects_v2 %} to view, create, and customize charts that use the items added to your project as their source data. You can apply filters to the default chart and also create your own charts. When you create a chart, you set the filters, chart type, the information displayed, and the chart is available to anyone that can view the project.
You can view your project as a high-density table layout, as a kanban board, or a timeline-style roadmap. For more information about the different layout options, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view). For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/about-insights-for-projects).
### Creating project templates
You can create project templates for your organization, or set a project as a template, to share a pre-configured project with other people in your organization which they can then use as the base for their projects. Project templates include the views, custom fields, draft issues and associated fields, configured workflows (except any auto-add workflows), and insights.
For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization).
### Sharing status updates
You can keep your team up to date and share high-level overviews, which people can use to determine the status of your project. You can set a status, such as "On track" or "At risk", to allow people to quickly determine the current state of the project. You can also set start dates and target dates. Your status update can also contain a message that supports formatting with Markdown. Status updates are found on your project's side panel, below the description and README, and in the project's header and in lists when you're browsing projects.
For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/sharing-project-updates).
## Next steps
Here are some helpful resources for taking your next steps with {% data variables.product.prodname_projects_v2 %}:
* To learn about getting started using projects, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects).
* To learn tips for managing your projects, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects).

View File

@@ -17,6 +17,10 @@ topics:
You can use {% data variables.product.prodname_projects_v2 %} to manage your work on {% data variables.product.company_short %}, where your issues and pull requests live. Read on for tips to manage your projects efficiently and effectively. For more information about {% data variables.product.prodname_projects_v2 %}, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects). You can use {% data variables.product.prodname_projects_v2 %} to manage your work on {% data variables.product.company_short %}, where your issues and pull requests live. Read on for tips to manage your projects efficiently and effectively. For more information about {% data variables.product.prodname_projects_v2 %}, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).
## Communicate across your issues and pull requests
Issues and pull requests include built-in features to let you easily communicate with your collaborators. Use @mentions to alert a person or entire team about a comment. Assign collaborators to issues to communicate responsibility. Link to related issues or pull requests to communicate how they are connected.
## Break down large issues into smaller issues ## Break down large issues into smaller issues
Breaking a large issue into smaller issues makes the work more manageable and enables team members to work in parallel. It also leads to smaller pull requests, which are easier to review. Breaking a large issue into smaller issues makes the work more manageable and enables team members to work in parallel. It also leads to smaller pull requests, which are easier to review.
@@ -25,11 +29,19 @@ To ensure efficient progress, clearly define which issues are blocked by, or blo
To track how smaller issues fit into the larger goal, use milestones or labels. For more information, see [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones) and [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels). To track how smaller issues fit into the larger goal, use milestones or labels. For more information, see [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones) and [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels).
## Communicate {% ifversion sub-issues %}
Issues and pull requests include built-in features to let you easily communicate with your collaborators. Use @mentions to alert a person or entire team about a comment. Assign collaborators to issues to communicate responsibility. Link to related issues or pull requests to communicate how they are connected. {% 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).
## Make use of the description, README, and status updates {% ifversion issue-types %}
You can also use issue types to classify work in repositories across the organization alongside sub-issues. For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization).
{% endif %}
{% endif %}
## Make use of the description, README, and status updates to share information about a project
Use your project's description and README to share information about the project. Use your project's description and README to share information about the project.
@@ -41,27 +53,52 @@ For example:
Project READMEs support Markdown which allows you to use images and advanced formatting such as links, lists, and headers. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project). Project READMEs support Markdown which allows you to use images and advanced formatting such as links, lists, and headers. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/creating-projects/creating-a-project).
You can also share high-level updates with other users of your project by posting status updates. Status updates allow you to mark the project with a status, such as "On track" or "At risk", set start and target dates, and share written updates with your team. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/sharing-project-updates). You can also share high-level updates with other users of your project by posting status updates. Status updates allow you to mark the project with a status, such as "On track" or "At risk", set start and target dates, and share written updates with your team. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/sharing-project-updates).
## Use views ## Create customized views of your project items
Use project views to look at your project from different angles. Use project views to look at your project from different angles using the table, board, and roadmap layout. Views allow you to manage your team backlog, weekly iterations, team roadmaps, and plans for a feature release, just to name a few.
For example: For example, you can customize views by:
* Filter by status to view all un-started items * Filtering by status to view all un-started items
* Group by a custom priority field to monitor the volume of high priority items * Grouping by a custom priority field to monitor the volume of high priority items
* Sort by a custom date field to view the items with the earliest target ship date * Sorting by a custom date field to view the items with the earliest target ship date
* Slicing by assignee to view team capacity
* Showing a field sum for an estimate to highlight complexity for a group of items
* Adding a column limit to a board column to maintain focus
For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view). Here is an example table layout:
## Have a single source of truth ![Screenshot showing an example table layout.](/assets/images/help/projects-v2/example-table.png)
To prevent information from getting out of sync, maintain a single source of truth. For example, track a target ship date in a single location instead of spread across multiple fields. Then, if the target ship date shifts, you only need to update the date in one location. Here is an example board layout:
{% data variables.product.prodname_projects_v2 %} automatically stay up to date with {% data variables.product.company_short %} data, such as assignees, milestones, and labels. When one of these fields changes in an issue or pull request, the change is automatically reflected in your project. ![Screenshot showing an example board layout.](/assets/images/help/projects-v2/example-board.png)
## Use automation Here is an example roadmap layout:
![Screenshot showing an example roadmap layout.](/assets/images/help/projects-v2/example-roadmap.png)
For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project).
## Use different field types to add metadata to your project items
Take advantage of the various field types to meet your needs and add metadata to your issues, pull requests, and draft issues for richer views. Youre not limited to the built-in metadata (assignee, milestone, labels, etc.) that currently exists for issues and pull requests. For example, you can add the following metadata as custom fields:
* A date field to track target ship dates
* A number field to track the complexity of a task
* A single select field to track whether a task is Low, Medium, or High priority
* A text field to add a quick note
* An iteration field to plan work week-by-week, including support for breaks
Use an iteration field to schedule work or create a timeline. You can group by iteration to see if items are balanced between iterations, or you can filter to focus on a single iteration. Iteration fields let you view work that you completed in past iterations, which can help with velocity planning and reflecting on your team's accomplishments. Iteration fields also support breaks to show when you and your team are taking time away from their iterations. See [AUTOTITLE](/issues/planning-and-tracking-with-projects/understanding-fields/about-iteration-fields).
Use a single select field to track information about a task based on a preset list of values. For example, track priority or project phase. Since the values are selected from a preset list, you can easily group or filter to focus on items with a specific value.
For more information about the different field types, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/understanding-fields).
## Use automation to keep your projects up to date automatically
You can automate tasks to spend less time on busy work and more time on the project itself. The less you need to remember to do manually, the more likely your project will stay up to date. You can automate tasks to spend less time on busy work and more time on the project itself. The less you need to remember to do manually, the more likely your project will stay up to date.
@@ -76,12 +113,35 @@ Additionally, {% data variables.product.prodname_actions %} and the GraphQL API
* For more information about the API, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects). * For more information about the API, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects).
* For more information about {% data variables.product.prodname_actions %}, see [AUTOTITLE](/actions). * For more information about {% data variables.product.prodname_actions %}, see [AUTOTITLE](/actions).
## Use different field types ## Create charts and insights to visualize and share progress
Take advantage of the various field types to meet your needs. You can use insights for {% data variables.product.prodname_projects_v2 %} to view, create, and customize charts that use the items added to your project as their source data. You can apply filters to the default chart and also create your own charts. When you create a chart, you set the filters, chart type, the information displayed, and the chart is available to anyone that can view the project.
Use an iteration field to schedule work or create a timeline. You can group by iteration to see if items are balanced between iterations, or you can filter to focus on a single iteration. Iteration fields also let you view work that you completed in past iterations, which can help with velocity planning and reflecting on your team's accomplishments. Iteration fields also support breaks to show when you and your team are taking time away from their iterations. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/understanding-fields/about-iteration-fields). For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/about-insights-for-projects).
Use a single select field to track information about a task based on a preset list of values. For example, track priority or project phase. Since the values are selected from a preset list, you can easily group or filter to focus on items with a specific value. ## Create project templates to standardize your workflows
For more information about the different field types, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/understanding-fields). You can create project templates for your organization, or set a project as a template, to share a pre-configured project with other people in your organization which they can then use as the base for their projects. Project templates include the views, custom fields, draft issues and associated fields, configured workflows (except any auto-add workflows), and insights.
For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/managing-project-templates-in-your-organization).
## Link projects to teams and repositories
You can add projects to your team to give the whole team collaborator access to their projects. When you add a project to a team, that project is listed on the team's projects page, making it easier for members to identify which projects a particular team uses.
For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-team).
You can also add projects to a repository that is owned by the same user or organization that owns the project.
For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-repository).
## Have a single source of truth
To prevent information from getting out of sync, maintain a single source of truth. For example, track a target ship date in a single location instead of spread across multiple fields. Then, if the target ship date shifts, you only need to update the date in one location.
{% data variables.product.prodname_projects_v2 %} automatically stay up to date with {% data variables.product.company_short %} data, such as assignees, milestones, and labels. When one of these fields changes in an issue or pull request, the change is automatically reflected in your project.
## Further reading
* [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)
* [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects)

View File

@@ -10,7 +10,5 @@ children:
- /about-projects - /about-projects
- /quickstart-for-projects - /quickstart-for-projects
- /best-practices-for-projects - /best-practices-for-projects
- /finding-your-projects
- /sharing-project-updates
allowTitleToDifferFromFilename: true allowTitleToDifferFromFilename: true
--- ---

View File

@@ -15,7 +15,7 @@ topics:
## Introduction ## Introduction
This guide demonstrates how to use {% data variables.product.prodname_projects_v2 %} to plan and track work. In this guide, you will create a new project and add a custom field to track priorities for your tasks. You'll learn how to create saved views that help you communicate priorities and progress with your collaborators. You'll also set up built-in workflows to manage the items in your project. This guide demonstrates how to use {% data variables.product.prodname_projects_v2 %} to plan and track work. In this guide, you will create a new project, customize views, and add custom fields to manage a team backlog, iteration planning, and a team roadmap to communicate priorities and progress with your collaborators. You'll also set up built-in workflows to automatically manage the items in your project and charts to visualize items in your project.
## Prerequisites ## Prerequisites
@@ -39,13 +39,13 @@ First, create an organization project or a user project.
{% data reusables.projects.project-description %} {% data reusables.projects.project-description %}
## Adding issues to your project ## Adding items to your project
Next, add a few issues to your project. Next, add a few items to your project.
{% data reusables.projects.add-item-via-paste %} {% data reusables.projects.add-item-via-paste %}
Repeat the above steps a few times to add multiple issues to your project. Repeat the above steps a few times to add multiple items to your project.
For more information and other ways to add issues to your project, or about other items you can add to your project, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project). For more information and other ways to add issues to your project, or about other items you can add to your project, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project).
@@ -55,16 +55,22 @@ Next, add a draft issue to your project.
{% data reusables.projects.add-draft-issue %} {% data reusables.projects.add-draft-issue %}
## Adding an iteration field ## Adding fields
Next, create an iteration field so you can plan and track your work over repeating blocks of time. Iterations can be configured to suit how you and your team works, with customizable lengths and the ability to insert breaks. Next, create custom fields to manage the iteration, priority, and estimates for your project items.
### Creating an iteration field
Create an iteration field so you can plan and track your work over repeating blocks of time. Iterations can be configured to suit how you and your team works, with customizable lengths and the ability to insert breaks.
{% data reusables.projects.new-field %} {% data reusables.projects.new-field %}
1. Select **Iteration** 1. Select **Iteration**
1. To change the duration of each iteration, type a new number, then select the dropdown and click either **days** or **weeks**. 1. To change the duration of each iteration, type a new number, then select the dropdown and click either **days** or **weeks**.
1. Click **Save**. 1. Click **Save**.
## Creating a field to track priority Specify an iteration for all items in your project.
### Creating a priority field
Now, create a custom field named `Priority` and containing the values: `High`, `Medium`, or `Low`. Now, create a custom field named `Priority` and containing the values: `High`, `Medium`, or `Low`.
@@ -74,11 +80,37 @@ Now, create a custom field named `Priority` and containing the values: `High`, `
1. To add additional fields, for "Medium" and "Low", click **Add option**. 1. To add additional fields, for "Medium" and "Low", click **Add option**.
1. Click **Save**. 1. Click **Save**.
Specify a priority for all issues in your project. Specify a priority for all items in your project.
![Screenshot showing a list of issues, each with a priority of "Low," "Medium," or "High" in the "Priority" field.](/assets/images/help/projects/priority-example.png) ![Screenshot showing a list of issues, each with a priority of "Low," "Medium," or "High" in the "Priority" field.](/assets/images/help/projects/priority-example.png)
## Grouping issues by priority ### Creating an estimate field
Create a custom field named `Estimate` to track the complexity for each item.
{% data reusables.projects.new-field %}
1. Select **Number**
1. Click **Save**.
Specify an estimate for all items in your project.
## Creating views
Create views to visualize your items in a table, board, and roadmap.
For more information on customizing views, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project).
### Creating a team backlog
You can use a table layout to visualize your team backlog as a spreadsheet, allowing you to view many fields and make edits.
Select visible fields for your view to communicate the priority and progress of your team backlog.
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 {% ifversion issue-types %}**Type**, {% endif %}**Status**, {% ifversion sub-issues %}**Sub-issues progress**, {% endif %}**Assignees**, **Linked pull requests**, **Priority**, and **Estimate**.
Next, group all of the items in your project by priority to make it easier to focus on the high priority items. Next, group all of the items in your project by priority to make it easier to focus on the high priority items.
@@ -86,37 +118,90 @@ Next, group all of the items in your project by priority to make it easier to fo
1. Click **{% octicon "rows" aria-hidden="true" aria-label="rows" %} Group**. 1. Click **{% octicon "rows" aria-hidden="true" aria-label="rows" %} Group**.
1. Click **Priority**. 1. Click **Priority**.
Now, move issues between groups to change their priority. Now, move items between groups to change their priority.
1. Choose an issue. 1. Choose an item.
1. Drag and drop the issue into a different priority group. When you do this, the priority of the issue will change to be the priority of its new group. 1. Drag and drop the item into a different priority group. When you do this, the priority of the item will change to be the priority of its new group.
## Saving the priority view You can also show the sum of the `Estimate` field for each priority group.
When you grouped your issues by priority in the previous step, your project displayed an indicator to show that the view was modified. Save these changes so that your collaborators will also see the tasks grouped by priority. {% data reusables.projects.open-view-menu %}
1. Click **{% octicon "number" aria-hidden="true" aria-label="number" %} Field sum**.
1. Select **Estimate**.
When you grouped your items by priority and added a field sum in the previous steps, your project displayed an indicator to show that the view was modified. Save these changes so that your collaborators will also see the tasks grouped by priority.
{% data reusables.projects.save-view %} {% data reusables.projects.save-view %}
You can share the URL with your team to keep everyone aligned on the project priorities. You can share the URL with your team to keep everyone aligned on the project priorities. When a view is saved, anyone who opens the project will see the saved view. Here, you grouped by priority, but you can also add other modifiers such as sort, filter, or layout.
When a view is saved, anyone who opens the project will see the saved view. Here, you grouped by priority, but you can also add other modifiers such as sort, filter, or layout. Next, you will create a new view with the layout modified. Finally, to indicate the purpose of the view, give it a descriptive name.
## Adding a board layout {% data reusables.projects.open-view-menu %}
1. Click **{% octicon "pencil" aria-hidden="true" aria-label="pencil" %} Rename view**.
1. Type the new name for your view.
1. To save changes, press <kbd>Return</kbd>.
To view the progress of your project's issues, you can switch to board layout. Next, you will create new views with different layouts.
The board layout is based on the status field, so specify a status for each issue in your project. For more information on customizing tables, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-table-layout).
Then, create a new view. ### Creating a weekly iteration board view
To view the progress of your project's items in a kanban board, you can use the board layout. The board layout is based on the status field by default, so specify a status for each item in your project.
First, create a new view.
{% data reusables.projects.new-view %} {% data reusables.projects.new-view %}
Next, switch to board layout. Next, switch to the board layout.
{% data reusables.projects.open-view-menu %} {% data reusables.projects.open-view-menu %}
1. Under "Layout", click **Board**. 1. Under "Layout", click **Board**.
When you changed the layout, your project displayed an indicator to show that the view was modified. Save this view so that you and your collaborators can easily access it in the future. To indicate the purpose of the view, give it a descriptive name.
{% data reusables.projects.open-view-menu %}
1. Click **{% octicon "pencil" aria-hidden="true" aria-label="pencil" %} Rename view**.
1. Type the new name for your view.
1. To save changes, press <kbd>Return</kbd>.
Add a filter for `iteration:@current` to only includes items from the current iteration.
You can also show the sum of the `Estimate` field for each status column.
{% data reusables.projects.open-view-menu %}
1. Click **{% octicon "number" aria-hidden="true" aria-label="number" %} Field sum**.
1. Select **Estimate**.
When you added a filter and added a field sum in the previous steps, your project displayed an indicator to show that the view was modified. Save this view so that you and your collaborators can easily access it in the future.
{% data reusables.projects.save-view %}
For more information on customizing boards, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-board-layout).
### Creating a team roadmap
To view your project items on a timeline, you can use the roadmap layout. Roadmaps use custom date and iteration fields to position your issues, pull requests, and draft items on a timeline, allowing you to track work over time and watch progress.
First, create a new view.
{% data reusables.projects.new-view %}
Next, switch to the roadmap layout.
{% data reusables.projects.open-view-menu %}
1. Under "Layout", click **Roadmap**.
You can add vertical markers on a roadmap to show the milestones associated with items in your project.
1. In the top right of your roadmap, click **{% octicon "location" aria-hidden="true" aria-label="location" %} Markers**.
![Screenshot showing the menu bar in a roadmap layout. The "Markers" button is highlighted with an orange outline.](/assets/images/help/projects-v2/markers.png)
1. In the menu, select which markers you want to display on your roadmap.
When you added markers, your project displayed an indicator to show that the view was modified. Save this view so that you and your collaborators can easily access it in the future.
{% data reusables.projects.save-view %} {% data reusables.projects.save-view %}
@@ -127,7 +212,9 @@ To indicate the purpose of the view, give it a descriptive name.
1. Type the new name for your view. 1. Type the new name for your view.
1. To save changes, press <kbd>Return</kbd>. 1. To save changes, press <kbd>Return</kbd>.
## Configure built-in automation For more information on customizing roadmaps, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/customizing-the-roadmap-layout).
## Configuring built-in automation
Next, configure the auto-add workflow to automatically add issues opened in a repository with a specific label to your project. Next, configure the auto-add workflow to automatically add issues opened in a repository with a specific label to your project.
@@ -138,7 +225,7 @@ Next, configure the auto-add workflow to automatically add issues opened in a re
![Screenshot showing the workflow menu bar. The "Edit" button is highlighted with an orange rectangle.](/assets/images/help/projects-v2/workflow-start-editing.png) ![Screenshot showing the workflow menu bar. The "Edit" button is highlighted with an orange rectangle.](/assets/images/help/projects-v2/workflow-start-editing.png)
1. Under "Filters", select the repository you want to add items from. 1. Under "Filters", select the repository you want to add items from.
1. Next to the repository selection, type the filter criteria you want items to match before they are automatically added to your project. For example, to catch all issues and PRs opened with the label "bug", use `is:issue,pr label:bug`. 1. Next to the repository selection, type the filter criteria you want items to match before they are automatically added to your project. For example, to catch all issues and pull requests opened with the label "question", use `is:issue,pr label:question`.
1. To enable the new workflow, click **Save and turn on workflow**. 1. To enable the new workflow, click **Save and turn on workflow**.
Finally, add a built in workflow to set the status to **Todo** when an item is added to your project. Finally, add a built in workflow to set the status to **Todo** when an item is added to your project.
@@ -151,7 +238,22 @@ Finally, add a built in workflow to set the status to **Todo** when an item is a
1. Next to **Set**, select **Status:Todo**. 1. Next to **Set**, select **Status:Todo**.
1. Click the **Disabled** toggle to enable the workflow. 1. Click the **Disabled** toggle to enable the workflow.
For more information on automating your project and other default workflows you can configure to keep your project items up to date, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/automating-your-project).
## Viewing charts and insights
You can use insights for {% data variables.product.prodname_projects_v2 %} to view, create, and customize charts that use the items added to your project as their source data. You can apply filters to the default chart and also create your own charts by choosing the grouping, layout, X-axis, and Y-axis configuration.
{% data reusables.projects.access-insights %}
1. In the menu on the left, click **New chart**.
1. Optionally, to change the name of the new chart, click {% octicon "triangle-down" aria-label="The triangle icon" %}, type a new name, and press <kbd>Return</kbd>.
1. Above the chart, type filters to change the data used to build the chart. See [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects).
1. To the right of the filter text box, click **Save changes**.
For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/viewing-insights-from-your-project/about-insights-for-projects).
## Further reading ## Further reading
* [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project/adding-items-to-your-project) * [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects)
* [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view) * [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-items-in-your-project)
* [AUTOTITLE](/issues/planning-and-tracking-with-projects/understanding-fields)

View File

@@ -1,6 +1,8 @@
--- ---
title: 'Sharing {% data variables.projects.project_v2 %} updates' title: 'Sharing {% data variables.projects.project_v2 %} updates'
intro: 'You can post updates to your {% data variables.projects.projects_v2 %} that share the current status, start date, and target date of the {% data variables.projects.project_v2 %} itself.' intro: 'You can post updates to your {% data variables.projects.projects_v2 %} that share the current status, start date, and target date of the {% data variables.projects.project_v2 %} itself.'
redirect_from:
- /issues/planning-and-tracking-with-projects/learning-about-projects/sharing-project-updates
allowTitleToDifferFromFilename: true allowTitleToDifferFromFilename: true
versions: versions:
fpt: '*' fpt: '*'

View File

@@ -31,7 +31,7 @@ You can enable the "Parent issue" field to see which parent issues the issues in
1. Under "Hidden fields", click **Parent issue**. 1. Under "Hidden fields", click **Parent issue**.
## Enabling the Sub-issue progress ## Enabling the Sub-issue progress field
You can enable the "Sub-issue progress" field to see how many sub-issues have been completed. You can enable the "Sub-issue progress" field to see how many sub-issues have been completed.

View File

@@ -0,0 +1,33 @@
---
title: About pull request fields
shortTitle: About pull request fields
intro: 'You can show a linked pull request and the pull request reviewers in your projects.'
versions:
fpt: '*'
ghec: '*'
type: tutorial
topics:
- Projects
---
You can enable the "Linked pull requests" and "Reviewers" fields on your projects to see information about a pull request, making a project the way to plan and track your issues, pull request, and code.
## Enabling the Linked pull requests field
You can enable the "Linked pull requests" field to see the pull request linked to an issue, allowing you to see the state of the pull request.
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 **Linked pull requests**.
## Enabling the Reviewers field
You can enable the "Reviewers" field to see the reviewers on the pull request.
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 **Reviewers**.

View File

@@ -0,0 +1,24 @@
---
title: About the issue type field
shortTitle: About the issue type field
intro: 'You can show the type of the issue in your projects.'
versions:
feature: issue-types
type: tutorial
topics:
- Projects
---
If your organization uses issue types, you can enable the "Type" field on your projects to see the issue type and how the issue is classified in your organization, such as a bug, task, or feature.
For more about issue types, see [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization).
## Enabling the Type field
You can enable the "Type" field to see the type of the issue.
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 **Type**.

View File

@@ -13,6 +13,8 @@ children:
- /about-single-select-fields - /about-single-select-fields
- /about-iteration-fields - /about-iteration-fields
- /about-parent-issue-and-sub-issue-progress-fields - /about-parent-issue-and-sub-issue-progress-fields
- /about-pull-request-fields
- /about-the-issue-type-field
- /renaming-custom-fields - /renaming-custom-fields
- /deleting-custom-fields - /deleting-custom-fields
allowTitleToDifferFromFilename: true allowTitleToDifferFromFilename: true
@@ -20,4 +22,3 @@ redirect_from:
- /issues/planning-and-tracking-with-projects/understanding-field-types - /issues/planning-and-tracking-with-projects/understanding-field-types
- /issues/planning-and-tracking-with-projects/understanding-fields/about-tracks-and-tracked-by-fields - /issues/planning-and-tracking-with-projects/understanding-fields/about-tracks-and-tracked-by-fields
--- ---

View File

@@ -9,11 +9,11 @@ versions:
topics: topics:
- Issues - Issues
children: children:
- /about-issues - /learning-about-issues
- /configuring-issues
- /using-issues - /using-issues
- /administering-issues - /administering-issues
redirect_from: redirect_from:
- /issues/tracking-your-work-with-issues/creating-issues - /issues/tracking-your-work-with-issues/creating-issues
- /issues/tracking-your-work-with-issues/managing-issues - /issues/tracking-your-work-with-issues/managing-issues
- /issues/tracking-your-work-with-issues/configuring-issues
--- ---

View File

@@ -7,6 +7,7 @@ redirect_from:
- /articles/about-issues - /articles/about-issues
- /github/managing-your-work-on-github/about-issues - /github/managing-your-work-on-github/about-issues
- /issues/tracking-your-work-with-issues/creating-issues/about-issues - /issues/tracking-your-work-with-issues/creating-issues/about-issues
- /issues/tracking-your-work-with-issues/about-issues
versions: versions:
fpt: '*' fpt: '*'
ghes: '*' ghes: '*'
@@ -17,7 +18,7 @@ topics:
- Project management - Project management
--- ---
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 %} 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, and you can use {% data variables.projects.projects_v2 %} to plan and track the work for 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 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). 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).
@@ -43,7 +44,9 @@ You can define blocking relationships between issues using issue dependencies. I
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). 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).
{% 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). ## Using {% data variables.projects.projects_v2_caps %} to plan and track your work
{% data variables.projects.projects_v2_caps %} is strongly integrated with issues to plan and track the work for your team. 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).
## Staying up to date ## Staying up to date
@@ -63,8 +66,30 @@ You can @mention collaborators who have access to your repository in an issue to
{% 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). {% 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 %} {% endif %}
## Metadata on issues
You can add metadata to your issues, including {% ifversion issue-types %}issue types, {% endif %}labels and milestones to organize your issues.
See {% ifversion issue-types %}[AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization), {% endif %}[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels) and [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones).
{% ifversion sub-issues %}
## About sub-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).
{% endif %}
## 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). 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).
When a conversation in an issue is better suited for a discussion, you can convert the issue to a discussion. When a conversation in an issue is better suited for a discussion, you can convert the issue to a discussion.
## Next steps
Here are some helpful resources for taking your next steps with {% data variables.product.prodname_github_issues %}:
* To learn about getting started using issues, see [AUTOTITLE](/issues/tracking-your-work-with-issues/learning-about-issues/quickstart).
* To learn about the essentials for using GitHub's planning and tracking tools, see [AUTOTITLE](/issues/tracking-your-work-with-issues/learning-about-issues/planning-and-tracking-work-for-your-team-or-project).
* To learn more about how projects can help you with planning and tracking, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects).

View File

@@ -1,6 +1,6 @@
--- ---
title: Configuring issues title: Learning about issues
intro: 'Learn how to configure your repository to start using issues.' intro: 'Learn about issues and how to make the best of this powerful tool.'
versions: versions:
fpt: '*' fpt: '*'
ghes: '*' ghes: '*'
@@ -8,7 +8,7 @@ versions:
topics: topics:
- Issues - Issues
children: children:
- /about-issues
- /quickstart - /quickstart
- /planning-and-tracking-work-for-your-team-or-project - /planning-and-tracking-work-for-your-team-or-project
- /managing-issue-types-in-an-organization
--- ---

View File

@@ -11,12 +11,13 @@ topics:
- Projects - Projects
redirect_from: redirect_from:
- /issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project - /issues/tracking-your-work-with-issues/planning-and-tracking-work-for-your-team-or-project
- /issues/tracking-your-work-with-issues/configuring-issues/planning-and-tracking-work-for-your-team-or-project
--- ---
## Introduction ## Introduction
You can use {% data variables.product.prodname_dotcom %} repositories, issues, projects, and other tools to plan and track your work, whether working on an individual project or cross-functional team. You can use {% data variables.product.prodname_dotcom %} repositories, issues, projects, and other tools to plan and track your work, whether working on an individual project or cross-functional team.
In this guide, you will learn how to create and set up a repository for collaborating with a group of people, create issue templates and forms, open issues and use task lists to break down work, and establish a {% data variables.projects.project_v2 %} for organizing and tracking issues. In this guide, you will learn how to create and set up a repository for collaborating with a group of people, create issue templates and forms, open issues and break down work, and establish a {% data variables.projects.project_v2 %} for organizing and tracking issues.
## Creating a repository ## Creating a repository
@@ -66,7 +67,7 @@ Now that we created the bug report issue template, you are able to select it whe
![Screenshot of the "New issue" page for octo-org/project-octocat, with the option to use the "Bug report for Project Octocat" template.](/assets/images/help/issues/quickstart-issue-creation-menu-with-template.png) ![Screenshot of the "New issue" page for octo-org/project-octocat, with the option to use the "Bug report for Project Octocat" template.](/assets/images/help/issues/quickstart-issue-creation-menu-with-template.png)
## Opening issues and using task lists to track work ## Opening issues and breaking down work
You can organize and track your work by creating issues. For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue). You can organize and track your work by creating issues. For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue).
@@ -76,6 +77,22 @@ Here is an example of an issue created for a large initiative, front-end work, i
![Screenshot of an issue called "Front-end work for Project Octocat." The issue body includes a list of tasks to complete.](/assets/images/help/issues/quickstart-create-large-initiative-issue.png) ![Screenshot of an issue called "Front-end work for Project Octocat." The issue body includes a list of tasks to complete.](/assets/images/help/issues/quickstart-create-large-initiative-issue.png)
{% ifversion sub-issues %}
### Sub-issues example
{% 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).
{% ifversion issue-types %}
You can use issue types to classify work in repositories across the organization, such as tasks, bugs, and features. See [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization).
{% endif %}
![Screenshot of the sub-issues section below the issue description.](/assets/images/help/issues/sub-issue.png)
{% endif %}
### Task list example ### Task list example
You can use task lists to break larger issues down into smaller tasks and to track issues as part of a larger goal. {% ifversion fpt or ghec %} Task lists have additional functionality when added to the body of an issue. You can see the number of tasks completed out of the total at the top of the issue, and if someone closes an issue linked in the task list, the checkbox will automatically be marked as complete.{% endif %} For more information, see [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists). You can use task lists to break larger issues down into smaller tasks and to track issues as part of a larger goal. {% ifversion fpt or ghec %} Task lists have additional functionality when added to the body of an issue. You can see the number of tasks completed out of the total at the top of the issue, and if someone closes an issue linked in the task list, the checkbox will automatically be marked as complete.{% endif %} For more information, see [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists).
@@ -84,13 +101,17 @@ 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) ![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 %} ## Using labels to highlight project goals and status
### Breaking down your work with sub-issues You can create labels for a repository to categorize issues, pull requests, and discussions. {% data variables.product.prodname_dotcom %} also provides default labels for every new repository that you can edit or delete. Labels are useful for keeping track of project goals, bugs, types of work, and the status of an issue. See [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels#creating-a-label).
{% 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). Once you have created a label in a repository, you can apply it on any issue, pull request, or discussion in the repository. You can then filter issues and pull requests by label to find all associated work. For example, find all the front end bugs in your project by filtering for issues with the `front-end` and `bug` labels. See [AUTOTITLE](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests).
{% endif %} ### Label example
Below is an example of a `front-end` label that we created and added to the issue.
![Screenshot of an issue called "Front-end work for Project Octocat." In the right sidebar, in the "Labels" section, the "front-end" label is applied.](/assets/images/help/issues/quickstart-add-label-to-issue.png)
### Showing which issues are blocked by, or blocking, other work ### Showing which issues are blocked by, or blocking, other work
@@ -188,10 +209,12 @@ Below is a {% data variables.projects.projects_v1_board %} for our example Proje
You have now learned about the tools {% data variables.product.prodname_dotcom %} offers for planning and tracking your work, and made a start in setting up your cross-functional team or project repository! Here are some helpful resources for further customizing your repository and organizing your work. You have now learned about the tools {% data variables.product.prodname_dotcom %} offers for planning and tracking your work, and made a start in setting up your cross-functional team or project repository! Here are some helpful resources for further customizing your repository and organizing your work.
* [AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories) for learning more about creating repositories * [AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories) for learning more about creating repositories
* [AUTOTITLE](/issues/tracking-your-work-with-issues) for learning more about different ways to create and manage issues * [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects) for learning more about projects
* [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates) for learning more about issue templates
* [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels) for learning how to create, edit and delete labels
* [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists) for learning more about task lists
* [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects) for learning more about projects
* [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view) for learning how to customize views for projects * [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view) for learning how to customize views for projects
* [AUTOTITLE](/issues/tracking-your-work-with-issues) for learning more about different ways to create and manage issues
* [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates) for learning more about issue templates{% ifversion issue-types %}
* [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization) for managing issue types{% endif %}
* [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels) for learning how to create, edit and delete labels{% ifversion sub-issues %}
* [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/adding-sub-issues) for learning about adding sub-issues{% endif %}
* [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists) for learning more about task lists
{% ifversion projects-v1 %}- [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards) for learning how to manage {% data variables.projects.projects_v1_boards %}{% endif %} {% ifversion projects-v1 %}- [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards) for learning how to manage {% data variables.projects.projects_v1_boards %}{% endif %}

View File

@@ -12,11 +12,12 @@ topics:
- Project management - Project management
redirect_from: redirect_from:
- /issues/tracking-your-work-with-issues/quickstart - /issues/tracking-your-work-with-issues/quickstart
- /issues/tracking-your-work-with-issues/configuring-issues/quickstart
--- ---
## Introduction ## Introduction
This guide demonstrates how to use {% data variables.product.prodname_github_issues %} to plan and track a piece of work. In this guide, you will create a new issue and add a task list to track sub-tasks. You'll also learn how to add labels, milestones, assignees, and projects to communicate metadata about your issue. This guide demonstrates how to use {% data variables.product.prodname_github_issues %} to plan and track a piece of work. In this guide, you will create a new issue{% ifversion sub-issues %} and break it down into sub-issues{% endif %}. You'll also learn how to add labels{% ifversion issue-types %}, issue types{% endif %}, milestones, assignees, and projects to communicate metadata about your issue.
## Prerequisites ## Prerequisites
@@ -41,31 +42,37 @@ You can use markdown to add formatting, links, emojis, and more. For more inform
![Screenshot of the new issue form, with a title and body filled in.](/assets/images/help/issues/issue-title-body.png) ![Screenshot of the new issue form, with a title and body filled in.](/assets/images/help/issues/issue-title-body.png)
{% ifversion sub-issues %}
## Adding a task list ## Adding a task list
It can be helpful to break large issues into smaller tasks, or to track multiple related issues in a single larger issue. Add a task list to your issue by prefacing list items with `[ ]`. Reference existing issues by issue number or URL. You can use plain text to track tasks that don't have a corresponding issue and convert them to issues later. For more information, see [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists). You can also use plain text to track tasks that don't have a corresponding issue and convert them to issues later. For more information, see [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists).
![Screenshot of the new issue form, with the title and body filled in. The body includes the Markdown for a task list.](/assets/images/help/issues/issue-task-list-raw.png) ![Screenshot of the new issue form, with the title and body filled in. The body includes the Markdown for a task list.](/assets/images/help/issues/issue-task-list-raw.png)
## Assigning the issue
To communicate responsibility, you can assign the issue to a member of your organization. See [AUTOTITLE](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users).
![Screenshot of the new issue form. In the right sidebar, the "Assignees" section is outlined in a dark orange.](/assets/images/help/issues/issue-assignees.png)
## Adding labels ## Adding labels
Add a label to categorize your issue. For example, you might use a `bug` label and a `good first issue` label to indicate that an issue is a bug that a first-time contributor could pick up. Users can filter issues by label to find all issues that have a specific label. Add a label to categorize your issue. For example, you might use a `question` label and a `good first issue` label to indicate that an issue is a question that a first-time contributor could pick up. Users can filter issues by label to find all issues that have a specific label.
You can use the default labels, or you can create a new label. For more information, see [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels). You can use the default labels, or you can create a new label. For more information, see [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels).
![Screenshot of the new issue form. In the right sidebar, the "Labels" section is outlined in dark orange.](/assets/images/help/issues/issue-with-label.png) ![Screenshot of the new issue form. In the right sidebar, the "Labels" section is outlined in dark orange.](/assets/images/help/issues/issue-with-label.png)
## Adding milestones {% ifversion issue-types %}
You can add a milestone to track the issue as part of a date based target. A milestone will show the progress of the issues as the target date approaches. For more information, see [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones). ## Adding issue types
![Screenshot of the new issue form. In the right sidebar, the "Milestone" section is outlined in dark orange.](/assets/images/help/issues/issue-milestone.png) You can add an issue type to classify work across the organization. See [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/managing-issue-types-in-an-organization).
## Assigning the issue ![Screenshot of the new issue form. In the right sidebar, the "Type" section is outlined in dark orange.](/assets/images/help/issues/issue-type.png)
To communicate responsibility, you can assign the issue to a member of your organization. For more information, see [AUTOTITLE](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users). {% endif %}
![Screenshot of the new issue form. In the right sidebar, the "Assignees" section is outlined in a dark orange.](/assets/images/help/issues/issue-assignees.png)
## Adding the issue to a project ## Adding the issue to a project
@@ -73,10 +80,24 @@ You can add the issue to an existing project and populate metadata for the proje
![Screenshot of the new issue form. In the right sidebar, the "Projects" section is outlined in dark orange.](/assets/images/help/issues/issue-project.png) ![Screenshot of the new issue form. In the right sidebar, the "Projects" section is outlined in dark orange.](/assets/images/help/issues/issue-project.png)
## Adding milestones
You can add a milestone to track the issue as part of a date based target. A milestone shows the progress of the issues as the target date approaches. See [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones).
![Screenshot of the new issue form. In the right sidebar, the "Milestone" section is outlined in dark orange.](/assets/images/help/issues/issue-milestone.png)
## Submitting your issue ## Submitting your issue
Click **Submit new issue** to create your issue. You can edit any of the above fields after creating the issue. Your issue has a unique URL that you can share with team members, or reference in other issues or pull requests. Click **Submit new issue** to create your issue. You can edit any of the above fields after creating the issue. Your issue has a unique URL that you can share with team members, or reference in other issues or pull requests.
## Adding sub-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).
![Screenshot of the sub-issues section below the issue description. The "View more sub-issue options" button is highlighted with an orange rectangle.](/assets/images/help/issues/sub-issue-drop-down.png)
{% endif %}
## Communicating ## Communicating
After your issue is created, continue the conversation by adding comments to the issue. You can @mention collaborators or teams 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. For more information, see [AUTOTITLE](/get-started/writing-on-github). After your issue is created, continue the conversation by adding comments to the issue. You can @mention collaborators or teams 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. For more information, see [AUTOTITLE](/get-started/writing-on-github).
@@ -101,5 +122,6 @@ To break your issue down into more manageable tasks, you can add multiple levels
Here are some helpful resources for taking your next steps with {% data variables.product.prodname_github_issues %}: 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). * To learn more about issues, see [AUTOTITLE](/issues/tracking-your-work-with-issues/about-issues).
* To learn more about how projects can help you with planning and tracking, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects). * To learn about the essentials for using {% data variables.product.github %}'s planning and tracking tools, see [AUTOTITLE](/issues/tracking-your-work-with-issues/learning-about-issues/planning-and-tracking-work-for-your-team-or-project).
* To learn more about how projects can help you with planning and tracking, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects).
* To learn more about using issue templates{% ifversion fpt or ghec %} and issue forms{% endif %} to encourage contributors to provide specific information, see [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests). * To learn more about using issue templates{% ifversion fpt or ghec %} and issue forms{% endif %} to encourage contributors to provide specific information, see [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests).

View File

@@ -19,4 +19,5 @@ children:
- /creating-a-branch-for-an-issue - /creating-a-branch-for-an-issue
- /linking-a-pull-request-to-an-issue - /linking-a-pull-request-to-an-issue
- /about-slash-commands - /about-slash-commands
- /managing-issue-types-in-an-organization
--- ---

View File

@@ -1,8 +1,10 @@
--- ---
title: Managing issue types in an organization title: Managing issue types in an organization
intro: 'Learn about issue types and how to manage them in your organization.' intro: 'Learn about issue types and how to manage them in your organization.'
redirect_from:
- /issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization
versions: versions:
feature: 'issue-types' feature: issue-types
type: overview type: overview
topics: topics:
- Project management - Project management

View File

@@ -1 +1 @@
You can add sub-issues to an issue to quickly break down larger pieces of work into tasks. Sub-issues add support for hierarchies of issues on {% data variables.product.github %} by creating relationships between your issues. You can create multiple levels of sub-issues that accurately represent your project by breaking down tasks into exactly the amount of detail that you and your team require. You can add sub-issues to an issue to quickly break down larger pieces of work into smaller issues. Sub-issues add support for hierarchies of issues on {% data variables.product.github %} by creating relationships between your issues. You can create multiple levels of sub-issues that accurately represent your project by breaking down tasks into exactly the amount of detail that you and your team require.