부담없이 추가할 수 있어 5W1H로 쓸 수 있는 GitHub/GitLab의 Issue 템플릿을 만들었다

소개

지인 몇 명과 개발을 하고 있어, 리모트 리포지토리에 GitHub 를 사용하고 있었습니다만, Issue 의 품질에 통일감이 없어, 보기 힘들었던 일이 있었습니다.

그래서 Issue의 품질을 통일하고자 Issue 템플릿이라는 것이 있다는 것을 깨달았습니다. Issue 템플릿을 공부하고 5W1H로 쓸 수 있는 템플릿을 만들고 게시했습니다.





관심있는 분은 아래 링크에서 템플릿을 다운로드하여 사용해보십시오. 도입 방법도 아래 링크에 기재되어 있습니다. GitHub이나 GitLab에 익숙하지 않은 분들도 절차에 따라 부담없이 추가할 수 있도록 의식적으로 만들었으므로 꼭 한번 시도해 보세요.

야스 히사 / 기테 b mp

또한 내가 속한 팀에서는 GitHub 이외에 GitLab을 사용하는 프로젝트도 있었으므로 GitLab의 Issue 템플릿도 만들고 추가했습니다.

Issue 템플릿을 추가하는 방법

리포지토리 코드를 다운로드합니다. (방법을 모르면 브라우저에서 링크 대상에 액세스하고 Code → Download ZIP을 클릭하여 압축을 풀어주세요)

원격 리포지토리에 맞는 디렉토리 (.github 또는 .gitlab)를 복사합니다.

리포지토리 바로 아래 (루트)에 붙여 넣습니다.

추가 한 파일을 원격 리포지토리에 푸시합니다.

추가되는 것

Issue 템플릿

Issue 개요

Issue가 무엇을 해결할지 추가/변경/삭제하는 방법

참고 링크(있는 경우)

끌어 오기 요청/병합 요청 템플릿

변경 사항

리뷰로보고 싶은 포인트 (요점 리뷰시 기재)

관련 Issue

참고 링크(있는 경우)

리포지토리 가이드 라인 (CONTRIBUTING.md)

이 저장소에 끌어 오기 요청을 보내려면

Issue 만드는 법

브랜치 작성 예

Pull Request를 만드는 방법

Issue에는 "기능 추가"와 "작동 불량"이라는 두 가지 유형의 템플릿이 추가됩니다. 기능 추가는 enhancement 라벨, 동작 불량은 bug 라벨이 자동으로 붙습니다.

실제로이 템플릿을 사용한 Issue 및 Pull Request 예제

Issue

Pull Request

리포지토리 가이드라인(CONTRIBUTING.md)

결론

프로젝트에 따라 리포지토리의 운영 규칙은 다양합니다만, 범용적으로 사용할 수 있을 것 같은 내용으로 했습니다.

5W1H의 Issue를 강제하는 것은 조금 귀찮게 됩니다만, 잘 모르는 Issue를 만들지 않으면, 후속의 커뮤니케이션을 원활하게 진행될까라고 생각하고 있습니다.

추가 요청이 있으면 위의 리포지토리에 기능 추가 Issue를 만들어 주시면 감사하겠습니다.

참고

리포지토리에 대한 Issue 템플릿 설정 - GitHub Docs

Description templates | GitLab