Quickstart for GitHub Issues

Follow this brief interactive guide to learn about 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. You'll also learn how to add labels, 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 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에 쓰기.

Screenshot of the new issue form, with a title and body filled in.

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에 쓰기.

Screenshot of an issue comment. The header says "octocat commented now" and the body says "@hubot Do we also need to update the rocket logic?"

Next steps

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

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

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