3. Pull Request, Commit, Issues Templates

Pull Request

• 예시

1. Fixes #{이슈번호}

• 하이퍼링크를 통해 이슈번호로 바로 이동할 수 있게 하여 어떤 이슈에 관련된 PR인지 알기 쉽게 하였습니다.
• 해당 PR Merge되면 자동으로 Issue가 Close될 수 있도록 편의성을 높였습니다.

구체적인 사항은 GitHub Docs에서 확인하실 수 있습니다.

2. 개요

• 문제상황, PR의 목적, 개선효과 등을 요약해서 리뷰어나 다른 개발자가 해당 PR에 대해 쉽게 파악할 수 있도록 하였습니다.

3. 작업사항

• 체크박스 형태로 현재 진행한 작업사항을 명시합니다.
• 리뷰어가 현재 진행상황을 쉽게 파악할 수 있도록 하였습니다.

Commit

템플릿 :

[#현재 이슈 번호] : (카테고리) : 해당 이슈에 대한 한줄 요약 (관련된 이슈 번호)

예 : [#80] test : 카페에 좋아요를 누른 유저들을 조회할 수 있는 기능을 검증하는 통합 테스트 추가 (#79)

구체적인 사항은 conventionalcommits.org에서 확인하실 수 있습니다.

• <카테고리> : <제목> 형식으로 작성하며 제목은 최대 50글자 정도로만 입력합니다.
• 제목을 아랫줄에 작성, 제목 끝에 마침표 금지, 무엇을 했는지 명확하게 작성성합니다.
• 본문(추가 설명)을 아랫줄에 작성성합니다.
• 꼬릿말(footer)을 아랫줄에 작성 (관련된 이슈 번호 등 추가)합니다.

• <카테고리> 종류
• 다른 개발자가 봤을 때 무슨 종류의 커밋인지 한눈에 알아보기 쉽도록 하기 위해 커밋 시작부에 알맞은 카테고리를 기입합니다.
• feature : 새로운 기능 추가
• fix : 버그 수정
• docs : 문서 수정
• test : 테스트 코드 추가
• refactor : 코드 리팩토링
• style : 코드 의미에 영향을 주지 않는 변경사항
• chore : 빌드 부분 혹은 패키지 매니저 수정사항

Issues Templates

PR에 구체적인 내용이 있기 때문에 다른 개발자가 어떤 이슈였는지 쉽게 알 수 있도록 간결하고 직관적으로 작성하도록 합니다.

AS-IS

• 이슈가 해결되기 전 현재 프로젝트 상황에 대해 기술합니다.

TO-BE

• 이슈가 해결된 후의 상황, 해결 됐을 때의 효과 등을 기술합니다.

진행상황 (Optional)

• Pull Request와 동일한 역할을 합니다. 필요에 따라 생략할 수 있습니다.

부가설명 (Optional)

• 위의 양식으로 설명이 어렵다면 플로우 차트나 UML등의 이미지를 활용하여 더 구체적으로 부가설명을 할 수 있습니다.