Dsence
154
2017-02-17 16:37:31.0
5
757

추천하시는 commit 메세지가 있으신가요?



좋은 commit 메세지란 무엇일까요


간략하고 한눈에 알아보기 쉽게 함축해야 하는 것인가요 ?


아니면 업데이트한 내용을 상세히 적는것이 좋은걸까요 ?



commit 메세지를 보통 어떻게 작성하시는지 궁금하네요


또 보기 좋은 commit 메세지가 어떤것들이 있는지도 궁금하네요


0
0
  • 댓글 5

  • iview83
    1k
    2017-02-17 16:46:14.0
    추가 수정 삭제시 정상동작 보장 안합니다. 
    0
  • BK
    92
    2017-02-17 17:00:23.0 작성 2017-02-17 17:00:42.0 수정됨


    어디 번역본들이 있을텐데...

    대충 요점은:

    1. 첫줄만 간략하게 50자 이내로 작성하고,
    2. 한줄 띄우고
    3. 업데이트한 내용을 육하원칙으로 상세히 적는게 좋은데...


    이렇게 가르쳐 놓으면 너무 형식에 스트레스 받는 친구들이 많더라구요.

    자고로 Form follows Function (형태는 기능에 따른다)이라고,

    형식이 어찌됐건 궁극적으로 추구해야할 원칙은 "배려"죠.

    같이 일하는 개발자 동지들, 프로젝트 중간에 언제 들어올지도 모르는 꼴통 신입들을 비롯해, 해마다 성숙(?)해진 미래의 나를 "배려"하는 마음으로 성의있게 쓴다면 형식이 뭐 대수일까요.

    0
  • John84
    1k
    2017-02-17 18:19:28.0

    최대한 간결하게 쓰려고 노력합니다

    그러다 보니 커밋이 많아 집니다ㅠㅠ


    0
  • Taetrees
    324
    2017-02-18 11:15:12.0

    전 편지같은 방식일 좋다고 생각해요.

    제목 + 본문 내용!

    게임 업데이트 되면 상세히 하나하나 기술하는 것보다 더 자세히 기술해야한다고 생각하는데

    보는 상대가 나와 같은 개발자이기 때문에 그 사람들이 봤을 때도 무엇이 변경되었고

    어떤 잠재적 문제가 있을 수 있는지에 대해서 나름 상세히 기술해야 다른 사람이 그 코드를 보거나

    작업할 때 이해하기 쉽다고 생각합니다.

    실무에서 보면 급하다고 .(점) 하나 찍고 커밋하는 사람도 있고

    날짜가 남은에도 불구하고 '몇 일자 변경' 등과 같은 별 의미없는 메시지를 남기는 경우도 많죠.


    커밋 메시지도 코드의 연장선이고 자기 얼굴이라고 생각하는 마음에서

    남에게 편지 쓰는 마음으로 써야한다고 저는 생각합니다.

    사람마다 다른 기준이 있겠지만요...

    0
  • 배고파서서러워요
    163
    2017-02-24 12:48:04.0

    저같은 경우에는 제목으로 변경점 기술하고

    본문에 변경 소스 위치(표시야 되지만 찾으려면 귀찮아지니)와, 변경 이유, 변경 내용을 기술하는 편입니다.


    제목 : 로그인 쿼리 변경.
    수정 위치 : /a/b/c 
    변경 이유 : 패스워드 암호화 방식 변경.
    변경 내용 : salt 키 생성방식 변경 기존소스 => 현재소스

    이런식으로요..

    물론 매번은 이렇게 못했지만, 가능한 한 이렇게 쓰려고 노력했습니다.

    현재는 버전관리 안하는 회사라(.....)

    0
  • 로그인을 하시면 댓글을 등록할 수 있습니다.