📜 Git
:: ✍ 작업으로 의사소통하기 - 매너가 사람을 만든다
:: commit 으로 소통하기
commit message convention
- 각 조직마다 commit message 작성하는 것에 대한 규칙이 있음
:: 좋은 commit message 작성하기
- 제목과 본문을 한 줄 띄워 분리하기 (50자 이내 요약문장, 빈 줄 1개, 설명문)
- 제목은 영문 기준 50자 이내로 (50자가 힘들다면 69자로 시작)
- 제목 첫글자를 대문자로
- 제목 끝에 . 금지
- 제목은 명령조로 (git의 빌트-인 컨벤션(Built-in Convention)을 그대로 따른다는 것을 의미) ~해라
- 본문은 영문 기준 72자마다 줄 바꾸기
- 본문은 어떻게보다 무엇을, 왜에 맞춰 작성하기
commit message 작성하면 좋은점
- 일관적인 규칙을 만들어 커밋 단위 적절하게 끊어야 함
- 커밋 히스토리만 봐도 알 수 있음
- 버그를 찾거나 코드 고칠 때 쉬움
- 다른 사람이 코드리뷰할 때 편함
좋은 git commit 메시지를 위한 영어 사전 - by Reid
- 동사는 영어로 나머지는 한글로 이런식 (Add 김치찌개 육수 조리법)
- 규칙을 꼭 지켜야한다가 아니라 협업을 잘하기 위한 의사소통!
- 관심있는 프로젝트에서 어떤 스타일로 commit 메시지를 commit 히스토리를 살펴보면서 배우기
- Github 에서 정보찾기
:: commit message 작성 예
commit message 템플릿 적용하기
- sourcetree mac에서만 제공
키워드 - 기능, 단위#issue번호
변경사항 :
- 키워드: 생성, 수정, 추가,고치기,문서화,스타일, 테스트
- "왜", "무엇"을 포함하기
- 제목은 80자 이내로, 긴 내용은 줄바꿈하고 본문에서
생성예제 오징어 김치전 요리법, 단위#100 변경사항: 기존 김치전 요리법을 복사해서 오징어가 들어간 김치전 요리법 만듦
:: ✍ 코드리뷰로 서로에게 피드백주기
:: 코드 리뷰(code review)
- 기능, 버그, 더 나은 솔루션이 있는지를 중점적으로 봄
:: 코드리뷰하는 이유
- 코드의 품질 높일 수 있음
- 다른 사람의 눈으로 버그 빠르게 발견 가능
- 서로의 지식을 나누며, 더 나은 방법을 찾아낼 수 있음
내가 만든 코드가 아닌 팀의 코드의 품질을 높인다.
- 코드리뷰 하는 방법은 각 조직마다 다름
- 조직에 속하지 않고 개발한다면 코드리뷰 서로 주고 받을 친구나 팀원을 구해보기
- 코드리뷰는 하는 것도 받는것도 모두 도움이 됨
google 코드리뷰 가이드 문서
google 코드리뷰 가이드 한글번역(비공식) - by sooginro
:: github 이용한 코드리뷰
- 각자 작업공간 분리되어 있어 코드리뷰 후 수정 쉬움
- PR페이지를 통해 댓글로 리뷰 주고 받을 수 있음
:: PR과 셀프 코드리뷰
- myProblem이라는 브랜치 만들어 kimchi-recipe에 요즘 프로그래밍하면서 고민하고 있는 코드 PR해보기
- 그리고 셀프로 코드리뷰해보기
