근데 왜 깔끔하게 해야함?
일단 제가 더러운걸 ㅈㄴ 싫어합니ㄷ
그리고 요즘은 IT 관련 회사에서 면접자에 깃허브를 보는 곳이 많답니다.
실제로 깃허브로 포폴을 보는 경우도 많구요.
근데 깃허브에 커밋로그가 더러우면, 그 사람을 뽑아줄까요?
뽑는경우도 있긴하지만 협업에서도 중요한건 커밋입니다.
커밋로그가 깔끔하면, 그사람에 협업에서에 능력도 조금 올라가죠.
하지만 커밋로그가 더럽다면? 면접관님에 눈이 조금 찌푸려질것입니다.
그래서 어떻게 깔끔하게 하는데?
그래서 어케 하는건데
주변 블로그들을 보면 커밋 메세지에 7가지 규칙을 지키라 합니다.
- 제목과 본문을 빈 행으로 구분합니다.
- 제목을 50글자 이내로 제한합니다.
- 제목의 첫 글자는 대문자로 작성합니다.
- 제목의 끝에는 마침표를 넣지 않습니다.
- 제목은 명령문으로! 과거형을 사용하지 않습니다.
- 본문의 각 행은 72글자 내로 제한합니다.
- 어떻게 보다는 무엇과 왜를 설명합니다.
머.. 어케하라는건지는 설명을 안해주면서 하라고 하면 누가 하겠습니까?
그래서 제가 직접 해보았습니다.
1. 제목과 본문을 빈 행으로 구분합니다.
함 해보겠습니다.
아 참고로, 커밋을 여러줄로 하려면 git bash를 열어서 평소처럼 commit 메세지 적는데 "만 안붙이시면 됩니다. 마지막줄에 따음표 붙이심 될듯.
2. 제목을 50글자 이내로 제한합니다.
3. 제목의 첫 글자는 대문자로 작성합니다.
4. 제목의 끝에는 마침표를 넣지 않습니다.
이건 여러분들도 하실 수 있습니다.
그냥 문법만 안틀리면 가능하죠.
- feat : 새로운 기능 추가
- fix : 버그 수정
- docs : 문서 수정
- style : 코드 formatting, 세미콜론(;) 누락, 코드 변경이 없는 경우
- refactor : 코드 리팩토링
- test : 테스트 코드, 리팽토링 테스트 코드 추가
- chore : 빌드 업무 수정, 패키지 매니저 수정이걸 제목에 첫줄에 적어주시는게 국룰이랍니다.
5. 제목은 명령문으로! 과거형을 사용하지 마라
이건 무슨 뜻일까요?
네. 말 그대로 과거형(~를 했다.)를 쓰지 말라는 겁니다.
fixed : !@#$#@%^#$%#$%^요론거 하지 말라는겁니다.
fix : @#$%@#$%@#$%@#$이렇게 해야 합니다.
6. 본문과 각 행은 72글자 내로 제한합니다.
사실 이건 쉽습니다.
본문은 여러분드링 무엇을 수정했고, 왜 수정했는지 적으면 됩니다.
72글자 이내로요.
7. 어떻게 보다는 무엇과 왜를 설명합니다.
~~~ 이부분을 ~~~이렇게 수정했습니다~본문을 이런식으로 적으면 어떤 파일을 수정했는지, 왜 수정했는지 알수가 없습니다
~~~ 파일을 ~~~한 이유로 인해서 수정했습니다~이렇게 적어주셔야 무슨 파일을 어떤 이유로 인해서 수정했는지 알수가 있습니다.
정리
그래서 머 대충 이런식으로 해주시면 됩니다.
근데 한글 쓰면 안되는거 아님?
네. 제목에서만은요.
본문에선 한글? 얼마든지 사용해도 됩니다.
본문은 자세한 설명을 적기 위해 존재하는데 대체 왜 그 ㅈ같은 영어를 쓰면서까지
자세한 설명을 하려는지 모르겠네요.
오히려 이해하기 어렵습니다.
이제 할만하죠?
이렇게 제 ㅈ같은 지식으로 커밋룰을 설명해드리고, 어떻게 수정하는지도 알려드렸습니다.
이젠 커밋, 깔끔스하게 하시면 됩니다.
저기서 더 추가하시려면 이모티콘정도? 하시면 됩니다.
예. 저는 여기서 물러나겠습니다.
