Github에서 Issue를 생성하기 위해 Issue Template을 생성해보고, Issue를 통해 작업 관리를 해보는 실습을 진행합니다.

실습 준비

해당 실습 자료는 1. Github Repository 생성하기에서 이어집니다.

1. Issue Template 생성하기 (1) - Github 에서 생성하기

   • Github Repository의 Settings로 이동합니다.

     

   • 스크롤을 내려보면 Features - Issues 항목의 Set up templates 버튼을 클릭하여 Template을 생성할 수 있습니다.

     

   • Add template을 눌러 기본으로 설정된 템플릿을 기반으로 생성할 수 있습니다.

     • Bug report - 프로젝트에 버그 리포팅을 위한 템플릿을 생성할 수 있습니다.
     • Feature request - 프로젝트에 새로운 기능을 제안하는 템플릿을 생성할 수 있습니다.
     • Custom template - 그 외에 템플릿을 생성할 때 사용하는 기본 템플릿 입니다.

     

   • 먼저, Feature request를 추가해보겠습니다.

     • Preview and edit 버튼으로 내용을 수정할 수 있습니다.

     

   • 다음과 같이 Feature request의 기본 템플릿을 확인할 수 있고, 이름 오른쪽에 수정 버튼으로 수정할 수 있습니다.

     

   • 템플릿을 수정해보겠습니다. 템플릿에 들어갈 내용과 제목의 기본값을 넣어줍니다.

     • Template content

       • Background - 작업의 배경을 작성합니다.
       • Todo - 해야할 작업들을 나열합니다. (SubTask 개념)
       • See also - 해당 Issue와 관련있는 다른 Issue 혹은 Pull Request의 태그를 작성합니다.

       ## Background
       - 
       
       ## Todo
       - [ ] Todo 1
       - [ ] Todo 2
       
       ## See also
       - #
       

     • Issue default title - [FEAT]

     

   • 우측 상단 Propose changes 버튼으로 저장할 수 있습니다.

     • 적절한 Commit Message와 함께 Commit 합니다.
     • 일반적으로는 main 브랜치에 바로 Commit을 하면 안되지만, Issue Template 추가는 프로젝트 초기 설정인 경우에는 별도의 feature 브랜치로 추가하지는 않습니다.

     

   • .github/ISSUE_TEMPLATE 경로에 Issue template이 추가되었습니다.

     

2. Issue Template 생성하기 (2) - Local Repository 에서 생성하기

   • Local Repository에는 main 브랜치에 추가한 내용이 없기 때문에 git pull origin main 명령어로 해당 내용을 가져옵니다.

     • .github/ISSUE_TEMPLATE 경로와 git log에 commit이 없는 것을 확인할 수 있습니다.

     

     git pull 명령어 실행 이전

     • .github/ISSUE_TEMPLATE 경로가 추가된 것을 확인할 수 있습니다.

     

     git pull 명령어 실행 이후

   • .github/ISSUE_TEMPLATE 경로의 feature_request.md 파일의 포맷은 다음과 같습니다.

     • 이와 동일한 포맷으로 Bug report 템플릿을 생성해보겠습니다.

     

   • 다음과 같이 Bug report 내용을 작성합니다.

     • Describe the bug - 버그에 대한 설명을 적습니다.
     • To Reproduce - 버그를 재현하는 방법을 적습니다.
     • Expected behavior - 정상적으로 작동했다면, 일어나야하는 작동 방식에 대해 적습니다.
     • Screenshots - 버그가 관측된 스크린 샷이 있다면 첨부합니다.
     • Additional context - 버그와 관련된 추가 정보를 작성합니다.
     • Possible Solution - 버그를 해결할 가능성이 있는 해결책을 제안합니다. 필수적인 부분은 아닙니다.
     • Your Environment - 특정 환경에서만 발생하는 버그일 수 있으므로 실행 환경을 작성합니다.

     

   • 변경 사항을 Commit 을 하고 Github Repository로 Push 합니다.

     

   • Github Repository에 업로드된 결과를 확인할 수 있습니다.

     

3. Issue 기반으로 개발하기 - 작업 정의하기

   • Github Repository의 Issues 탭에서 New Issue 버튼으로 Issue를 생성할 수 있습니다.

     

   • 생성한 Template을 확인할 수 있습니다.

   

   • Feature request 템플릿을 선택하면 다음과 같이 나옵니다.

     • 작업에 맞게 Issue를 생성하면 됩니다.

     

   • 더하기 함수를 구현하는 Issue를 생성해보겠습니다.

     • 연관된 다른 Issue나 Pull Request는 없으니 Background와 Todo 항목만 작성합니다.
     • 담당자와 라벨도 붙여보겠습니다.

     

   • Issue가 생성되었습니다.

   

4. Issue 기반으로 개발하기 - 코드 구현하기

   • git branch 명령어로 브랜치를 생성합니다.

     • feat-1/add-function → #1 태그를 갖는 이슈에 대한 feature 브랜치

     

   • 다음과 같이 main.py 스크립트를 작성합니다.

     • 두 개의 숫자 변수를 받아 더한 값을 반환하는 함수 입니다.

     

   • 메시지와 함께 commit을 남깁니다.

     • Footer 부분에 #1 로 Issue Tag를 남깁니다.

     

   • Github Repository origin의 feat-a/add-function 브랜치에 push 합니다.

     

   • Issue 페이지로 가보면, 다음과 같이 방금 업로드한 Commit이 보여집니다.

     • Push한 Branch는 Pull Request 실습에서 이어서 진행하도록 하겠습니다.