-
코드 리뷰, 커밋 메시지, 코드 컨벤션 정리개발하면서/etc 2015. 12. 31. 23:31반응형
간만에 쉬는 시간을 갖게되어 branch 전략이나 커밋 메시지, 코드 컨벤션에 대해 다른 사람들은 어떻게 했는지
살펴보고 정리 하려 한다. (그동안 정말 구현하기에 급급...ㅜ,ㅜ)
우선 이런 마음가짐으로 팀원과 맞춰가자
빡빡하게 하나부터 열까지 규칙 정하지 않고 널널하게 하자.(말이 애매한데, '굵은것만 정하자...'정도로 생각함)
실력있는 동료이니 조금 다른 규칙도 충분히 이해되기 때문에 그렇다. 조금 다르더라도 익숙해지도록 노력하고, 정~~말 익숙하지 않은
코드 스타일이 있다면 같이 얘기해서 수정해 나가면 좋겠다.
상대방을 존중하고 각자 성장을 원하는 개발자들이니까!!
존중과 신뢰, 그리고 코드 얘기만 해야지 사심이 들어가지 않도록 조심하자. 코드 리뷰
. master branch is always deployable. Github 의 P/R을 적극 활용. @을 사용하거나 설정을 통해 리뷰어들에게 메일이 가도록 설정하기. 제품의 품질 향상을 위해 하는거다. 커맨트를 할땐 권유? 형식으로 진행하기. 기능은 feat/xxxx, 버그 수정은 fix/xxx 브랜치로 만들기. 큰 기능 혹은 이해가 되지 않은 로직에 대해서는 직접 얘기하는게 좋을것 같다.. 커밋 메세지
SUBJECT
\n
BODY
http://www.laurencegellert.com/2013/07/how-to-write-a-proper-commit-message/
https://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message
http://chris.beams.io/posts/git-commit/
. JIRA 이슈단위로 움직이므로 HEAD에 이슈번호 붙이기
. SUBJECT는 50자, BODY는 72자 넘지 않도록 하기
(SUBJECT에 '.'찍지말라는데 이유는 한자한자가 아까운데 그걸 왜 쓰냐 정도,
50, 72숫자가 나온 이유는 git 만든 Linus가 권고 했다함 -_-;;). Github에 JIRA서비스 연동해서 full url을 적지 않아도 이슈 번호로만 JIRA 연동되도록 하기
. 상대방이 커밋 메시지를 읽은 후 코드 봤을때 이해가 쉽게 되도록 해야한다는 배려심
. 현재 nodeJS, Java, Scala를 사용하고 있다. 많은 사람들이 인정한 코드 컨벤션을 따르기로 한다. IntelliJ config로 만드는 작업 필요
. NodeJS는 airbnb, Java는 Google, Scala는 Scala doc, databricks
이 글을 작성하면서 다시 한번 느낀건 상대방 존중과 배려가 함께 해야한다는 점.
반응형