commit log 제대로 작성하기

2017-06-23 15:43

최근에 github이 활성화되면서 소스 코드에 대한 버전 관리는 많이 일반화되었다. 특히 프로그래밍 학습을 시작 단계부터 git을 활용하는 것은 의미있는 일이라 생각한다.

자신이 구현한 프로젝트 결과물을 git 저장소를 통해 제출하는 것만으로도 가산점이 있는 것 또한 사실이다. 사람을 채용하는 입장에서는 git 저장소의 소스 코드를 확인함으로써 개발자의 역량을 판단할 수 있기 때문에 더 좋은 수단이 될 수 있다.

초보 개발자가 git을 사용하는 것만으로도 의미가 있지만 이왕 사용하는 김에 제대로 사용하면 더 좋은 인상을 남길 수 있다. 그 중에서 commit log를 어떻게 남기느냐는 특히 중요하다는 생각이 든다. 무성의한 commit log보다는 구현 단계를 분리하고 각 단계에 대한 commit log를 제대로 남길 필요가 있다.

commit log에 대한 best practice는 널리 사용하는 것은 angular 진영에서 제공하는 Commit Message Conventions 이 유용한 듯해 공유한다.

특히 commit log에 다음과 같이 명확히 구분해 주는 것이 이 로그를 보는 사람에게도 많은 도움이 되겠다.

  • feat (feature)
  • fix (bug fix)
  • docs (documentation)
  • style (formatting, missing semi colons, …)
  • refactor
  • test (when adding missing tests)
  • chore (maintain)

이 정도의 구분만 명확히 하고 사용해도 좋은 commit log가 되겠다. commit log를 보고 실망한 면접관이 있어 글 남겨본다.

0개의 의견 from FB

2개의 의견 from SLiPP

2017-06-23 18:05

좋은 정보 감사합니다. 경험이 없는 초보 개발자 입장에서는 포트폴리오 등을 준비한다고 했을때, 어떤 기준으로 업무를 분담해야 할 지 모르기 때문에 잘 분담해서 진행하기 어렵고 git의 commit log를 보면서 함께 피드백하거나 리팩토링해서 코드의 완성도를 높이기보다는 일단은 돌아가게 만드는데 목적을 두게되고 그렇기 때문에 잘 모르지 않나 싶습니다.

이런 것들이 업계의 경험에서 오는 일이라 생각합니다. 그래서 자바지기님이 공유해주시는 글들이 좋은 정보가 되는 것 같아요.

장황하게 썻네요. 감사합니다

의견 추가하기

연관태그

← 목록으로