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 작업 목록 정보.

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 템플릿을 사용하여 유용한 이슈 및 끌어오기 요청 권장.