1) GitHub Commit Convention
개념
- Commit Convention은 Git commit 메시지를 작성할 때 지켜야 하는 규칙
- 일관된 형식을 사용하면 커밋 로그만 봐도 어떤 변화인지 쉽게 파악 가능
- 대표적으로 Conventional Commits 규칙이 많이 사용됨
기본 형식
<type>(<scope>): <subject>
<body>
<footer>
주요 type
feat: 새로운 기능 추가fix: 버그 수정docs: 문서 수정 (README 등)style: 코드 스타일 수정 (포맷팅, 세미콜론 등, 로직 변화 없음)refactor: 리팩토링test: 테스트 코드 관련chore: 빌드, 환경설정, 기타 잡일
예시
git commit -m "feat(auth): JWT 로그인 API 구현"
git commit -m "fix(order): 결제 시 NPE 발생 문제 해결"
git commit -m "docs(readme): 실행 방법 추가"
2) GitHub Pull Request(PR) Template
개념
- GitHub에서 Pull Request를 생성할 때 자동으로 표시되는 기본 양식
- 코드 리뷰, 테스트, 문서 업데이트 여부를 체크리스트로 관리 가능
- 프로젝트 루트에
.github/pull_request_template.md 파일을 추가하면 적용됨
예시
#### 작업 내용
- 이번 PR에서 작업한 기능/수정사항 요약
#### 체크리스트
- [ ] 코드가 정상적으로 동작하는가?
- [ ] 관련 테스트가 작성/수행되었는가?
- [ ] 문서(README 등)가 업데이트 되었는가?
