Home

Commit && Pull Request 규칙

1. Issue 등록

2. Branch 생성

• intra_id/issue_num/issue_keyword
• ex) hyojekim/1/project_setting

3. Commit message

conventional commit extension 사용

type: gitmoji 제목 #issue_num

Body

(Footer)

• 커밋메세지 한글로 작성 (가독성 선택)
• 커밋은 적당히 쪼개서 작성하기
• 관련된 이슈번호를 제목 옆에 넣고 footer는 옵션으로...

ex)
ci: 👷 프로젝트 자동화 설정 #1

이슈카드 자동화 설정 및 readme 수정
- 뭔가 더 자세히 써야하면 이렇게

type & gitmoji

• feat:✨ 새로운 기능 추가
• fix:🐛 버그 수정
• docs:📝 문서 수정
• style: 🎨 스타일 관련 기능 (formatting, ; 누락, 코드 자체 변경은 없을 경우)
• refactor:♻️ 코드 리팩토링
• test:🧪 테스트 코드, 리팩토링 테스트 코드
• chore:✏️ 자잘한 수정
• ci:👷 github action / project 설정

4. Rebase

• git rebase -i main (현재 branch)
• branch 원격 저장소에는 강제 push 해야하긴 하지만, 언제나 최신 상태의 main 위에서 작업할 수 있는 장점을 가짐

5. PR

• 상대방이 이해할 수 있도록 충분히 자세하게 작성하기
• 이해할 수 있다는 것은 이 커밋이 왜 필요했는지, 어떤식으로 수정되었는지, 어떤 결과가 나왔는지를 담고 있음을 의미
• closes를 사용해서 함께 종료될 issue가 있다면 연결해주기