Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 5.44 KB

File metadata and controls

64 lines (43 loc) · 5.44 KB
title intro redirect_from versions topics
About issues
Learn how you can use {% data variables.product.prodname_github_issues %} to track ideas, feedback, tasks, or bugs.
/github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests/about-issues
/articles/creating-issues
/articles/about-issues
/github/managing-your-work-on-github/about-issues
/issues/tracking-your-work-with-issues/creating-issues/about-issues
fpt ghes ghec
*
*
*
Pull requests
Issues
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 %}

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."

{% ifversion sub-issues %}

About sub-issues

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

{% data reusables.issues.about-sub-issues %} See "AUTOTITLE" and "AUTOTITLE."

{% endif %}

About integration with {% data variables.product.github %}

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."

{% 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."

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" and "AUTOTITLE."

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" and "AUTOTITLE."

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. See "AUTOTITLE."

{% ifversion fpt or ghec %}To maintain a healthy community, you can report comments that violate {% data variables.product.github %}'s Community Guidelines. See "AUTOTITLE."{% endif %}

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 %} See "AUTOTITLE" and "AUTOTITLE." {% endif %} {% ifversion 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."

{% ifversion converting-issues-to-discussions %}When a conversation in an issue is better suited for a discussion, you can convert the issue to a discussion.{% endif %} {% endif %}