Git Commit Convention 수립 시 지켜야 할 원칙

이상한모임 포스트 보고 감명받아서 까먹지 말기위해 쓴 포스트

  • convention 수립 시 까먹지 말자!.

1. 제목 과 본문 분리

  • git Kraken 애용하는데 애초에 여기서 분리하도록 ui 나와 있음

2. 제목 행 규칙

  • 50자 제한
  • github 최대치로 인해 69자 제한
    • illepsis 제거
  • 제목 행 마침표 제거
  • 행동 한 것을 간략 정리 한 명령문
  • 대문자 사용

3. 본문 규칙

  • 어떻게 보다는 왜 를 설명한다
  • 어떻게 는 코드를 보면 알 수 있다.
    • 여기서 중요한 것은 코드를 보면 어떻게 했는지 알 수 있을 만하게 코딩을 잘 하자는 것도 중요 한듯!?

고찰

  • 위의 1번 2번은 하면서 느끼던 것이라 자연스럽게 따르게 되던 규칙이더라.
  • 3번 규칙 은 보고서 아~!? 하고 insight를 얻었다.

결론

  • 잊지 말자! 커밋은 무엇과 왜! 를 설명 하도록 하자.