Github Naming Rule

Github Repository Naming Rule

1. 전부 소문자로 작성하고, 단어 사이에 - 사용.(Kebab case)
2. 최대한 명확하고 구체적으로 작성.
3. 일관적인 방식으로 작성.

Github Commit Title Type

깃허브 커밋의 제목은 type: subject 형태로 작성되어야 함. 이 때 type은 상황에 따라 다음 중 하나여야 함.

• feat: 새로운 기능을 추가
• fix: 버그 수정
• build: 빌드 관련 수정
• ci: CI 관련 수정
• docs: 문서 수정
• style: 코드 스타일 / 포맷 관련 수정
• refactor: 코드 리팩토링
• test: 테스트 코드 수정
• chore: 그 외 자잘한 수정

Github Commit Message Rule

1. 제목과 본문을 한 줄 띄워 분리. (Github Desktop 등을 사용한다면 신경쓰지 않아도 됨)
2. 제목은 영문 기준 50자 이내.
3. 제목 subject 부분의 첫 글자는 대문자로.
4. 제목 끝에 . 금지.
5. 제목을 명령문으로 작성.
6. 본문의 각 행을 72자로 제한.
7. 어떻게 변경되었는지 작성하는 것보다 무엇을 왜 변경했는지 작성.

References

1. https://beomseok95.tistory.com/328
2. https://stackoverflow.com/questions/11947587/is-there-a-naming-convention-for-git-repositories
3. https://cbea.ms/git-commit/
4. https://meetup.toast.com/posts/106