Quickstart for GitHub Issues

Introduction

This guide demonstrates how to use GitHub Issues to plan and track a piece of work. In this guide, you will create a new issue and break it down into sub-issues. You'll also learn how to add labels, issue types, milestones, assignees, and projects to communicate metadata about your issue.

Prerequisites

To create an issue, you need a repository. You can use an existing repository that you have write access to, or you can create a new repository. 具有托管用户的企业 成员只能对其企业一部分的存储库做出更改。 The repository must have issues enabled. For more information about creating a repository, see 创建新仓库. For more information about enabling issues if they are disabled in your repository, see 禁用议题.

Opening a blank issue

First, create an issue. There are multiple ways to create an issue; you can choose the most convenient method for your workflow. This example will use the GitHub UI. For more information about other ways to create an issue, see 创建议题.

1. 在 GitHub 上，导航到存储库的主页面。

2. 在存储库名称下，单击 “问题”。

   

3. 单击“新建问题”。

4. In this example, we will start with a blank issue. Your repository may use issue templates and issue forms to encourage contributors to provide specific information. If your repository uses issue templates, click Open a blank issue.

Filling in information

Give your issue a descriptive title. The title should convey at a glance what the issue is about.

Add a description that explains the purpose of the issue, including any details that might help resolve the issue. For example, if this is a bug report, describe the steps to reproduce the bug, the expected result, and the actual result.

You can use markdown to add formatting, links, emojis, and more. For more information, see 在 GitHub 上写入.

Adding a task list

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 About tasklists.

Assigning the issue

To communicate responsibility, you can assign the issue to a member of your organization. See 分配议题和拉取请求到其他 GitHub 用户.

Adding labels

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 管理标签.

Adding issue types

You can add an issue type to classify work across the organization. See Managing issue types in an organization.

Adding the issue to a project

You can add the issue to an existing project and populate metadata for the project. For more information about projects, see 关于 Projects.

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 关于里程碑.

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.

Adding sub-issues

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

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

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 在 GitHub 上写入.

Next steps

You can use issues for a wide range of purposes. For example:

• Tracking ideas
• Collecting feedback
• Planning tasks
• Reporting bugs

To break your issue down into more manageable tasks, you can add multiple levels of sub-issues. See 添加子问题.

Here are some helpful resources for taking your next steps with GitHub Issues:

• To learn more about issues, see About issues.
• To learn about the essentials for using GitHub's planning and tracking tools, see Planning and tracking work for your team or project.
• To learn more about how projects can help you with planning and tracking, see 了解 Projects.
• To learn more about using issue templates and issue forms to encourage contributors to provide specific information, see 使用模板鼓励有用的议题和拉取请求.