Git

깔끔하게 정리된 깃 메시지 및 깃 사용은 생산성의 증가로 이어진다
Commit message template
# <type>: <title> ##### Title-line. try to keep under 60 characters ############## -> | # Multi-line description of commit. Optional ######## try to keep under 70 characters ########################### -> | # Footer. Option: ex) #ex) Issue number #################### -> | # --- COMMIT END --- # <type> list # feat : new feature # fix : bug or view fix # refactor: refactoring # style : code style (no logic change) # docs : documents (add, mod, del) # test : test code (add, mod, del: no logic change # chore : etc (ex - mod build script, etc...) # ------------------
JavaScript
메시지 규칙
1. 제목과 본문을 한 줄 띄워 분리하기
본문을 꼭 넣지 않아도 될 때도 있습니다. 그러나 본문이 들어갈 때는 제목과 본문 사이에 한줄을 끼워 넣는 것이 가독성이 좋습니다 제목에는 어떤 부분을 수정, 혹은 기능을 추가했는지에 대해서 적을 수 있도록 합시다. 본문에는 에러 시 무엇이 원인이었는지, 왜 이렇게 해결했는지 등 참조할 수 있는 설명을 적을 수 있으면 좋습니다.
2. 제목은 50자 이내로
제목이 너무 길면 보기가 힘들고 잘 읽히지 않습니다. 가능하다면 간결하게 표현하는 것이 좋을 것 같습니다
3. 제목은 문장보다는 구문이 좋습니다
위의 연장선인데 '인증 에러를 고쳤다' 보다는 '인증 에러 수정' 과 같이 쓰는 것이 더 간결한 것 같습니다
4. 본문은 '무엇을', '왜'에 맞춰 작성하기
무엇을 했는지는 제목이 충분히 반영할 것입니다. 어떤 것을 추가, 수정했는지, 그리고 그 이유에 대해서 설명하는 것이 추후에 비슷한 에러 및 같은 에러를 발견했을 때 로그로서 가치가 있을 듯 합니다. 어떻게도 해당 로그 내 코드를 보면 알 수 있겠죠. 그래도 간결하게 어떻게 처리 했는지 로그가 필요 있다면 남깁시다.