Skip to main content

About issues

Learn how you can use GitHub Issues to track ideas, feedback, tasks, or bugs.

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 projects to plan and track the work for your team. You can also break your work down further by adding sub-issues and easily browse the full hierarchy of work to be done.

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, while adding sub-issues, 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, GitHub Desktop, GitHub CLI, GraphQL and REST APIs, or GitHub Mobile. See 创建议题.

提示

You can also use Copilot 对话助手 to generate ideas, outlines, or drafts for discussions or blog posts, based on your issues. See 撰写讨论或博客文章.

About sub-issues

可以向问题添加子问题,快速将较大的工作分解为任务。 子问题通过创建问题之间的关系,增加了对 GitHub 上的问题层次结构的支持。 可以创建多个层次结构级别,通过将任务精确地分解为你和你的团队所需的细节量来准确表示项目。 See 添加子问题 and 浏览子问题.

About issue dependencies

You can define blocking relationships between issues using issue dependencies. Issue dependencies let you identify issues that are blocked by, or blocking, other work. See Creating issue dependencies.

Metadata on issues

You can add metadata to your issues, including issue types, labels and milestones to organize your issues.

See Managing issue types in an organization, 管理标签 and 关于里程碑.

About integration with GitHub

Issues integrate with your work all across 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 将拉取请求链接到议题.

Using 项目 to plan and track your work

项目 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 关于 Projects.

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 关于通知 and Quickstart for your personal dashboard.

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 分配议题和拉取请求到其他 GitHub 用户 and 查看所有议题和拉取请求.

Community management

To help contributors open meaningful issues that provide the information that you need, you can use issue forms and issue templates. See 使用模板鼓励有用的议题和拉取请求.

To maintain a healthy community, you can report comments that violate GitHub's Community Guidelines. See 举报滥用或垃圾邮件.

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. See 基本撰写和格式语法 and 分配议题和拉取请求到其他 GitHub 用户.

Comparing issues and discussions

Some conversations are more suitable for GitHub Discussions. 您可以使用 GitHub Discussions 来提问和回答问题、共享信息、发布公告以及进行或参与有关项目的对话。 有关详细信息,请参阅“关于讨论”。 For guidance on when to use an issue or a discussion, see 在 GitHub 上通信.

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 GitHub Issues: