ManagingIssues

이슈 관리하기

아래와 같은 상황에서 작업을 시작하기 전, 새로운 이슈를 반드시 먼저 생성하여 작업에 대한 세부사항을 정하고 논의합니다. 각 작업을 누가 담당하는지, 진행이 얼마나 되었는지 쉽게 파악하기 위해 이슈 추적기를 사용합니다. 할 작업이나 논의사항이 있다면, 본격적으로 하기 전에 꼭 이슈를 먼저 생성하도록 합니다.

• 기능 추가/수정 작업이 필요할 때
• 사용자로부터 오류 보고를 받거나, 오류가 발견되어 수정이 필요할 때
• 큰 주제에 대한 논의가 필요할 때(대규모 리팩토링 작업, 규모가 큰 기능 추가 작업 등)
• 그 외 특정 주제에 관한 논의가 필요할 때

이슈 생성

• 저장소 페이지에서 Issues 탭으로 이동합니다.
• New issue 를 눌러 새로 이슈를 생성합니다.
  • 제목과 내용을 작성합니다.
    • 기능 추가/수정 작업에 관한 이슈의 경우, 구현하거나 수정해야할 것에 대한 상세 사항을 기입합니다.
    • 오류 수정과 관련된 경우, 오류 증상과 오류 제한 방법을 자세히 기술합니다.
    • 그 외의 경우, 논의할 사항에 대해 어떤 점을 논의할 것인지 기술합니다.
  • Assignees
    • 이슈 담당자를 정합니다. 작업에 실제로 참여할 사람 또는 논의를 이끌 사람을 지정합니다. 두 명 이상 지정 가능합니다.
  • Labels
    • 이슈 분류를 위해 이슈와 관련된 라벨을 지정해 줍니다.

이슈 참조하기

• 이슈와 관련된 작업지 진행되어 커밋을 할 때는, 커밋 메시지에서 해당 이슈를 참조 하도록 합니다. 메시지에 (#이슈번호) 를 포함하여 참조합니다. 이렇게 하면 해당 이슈에서도 해당 커밋을 참조할 수 있습니다.
  • (closes #이슈번호)를 커밋 메시지에 넣으면, 해당 커밋이 병합될 때 이슈가 자동으로 닫힙니다.
• 다른 이슈나 Pull Request 에서 참조하려면 내용에 #이슈번호 를 넣으면 자동으로 참조 됩니다.

이슈 닫기

이슈 안에서 이슈가 다루는 작업이 완료 되었거나, 논의가 끝난 경우 이슈를 닫아서 종결 처리 하도록 합니다. 각 이슈 페이지에서 Close issue를 눌러 직접 닫거나, 커밋 메시지에 (closes #이슈번호) 를 포함하여 커밋을 통해 자동으로 닫을 수도 있습니다.