좋은 git 커밋 메세지 작성 / 좋은 PR 작성

 

 

 

좋은 git 커밋 메세지 작성

---

참고 : https://meetup.toast.com/posts/106

좋은 git 커밋 메시지를 작성하기 위한 7가지 약속 : TOAST Meetup

 

최근 듣고 읽고 경험한 정보를 기반으로 나만의 커밋 메세지 원칙을 정했다!

 

• 처음 PR을 보낼 때는, 1 목적 = 1 커밋 = 1 PR

• 커밋 작성 시에는 

  • 영어, 명령문으로 시작하는 제목

    • (If applied, this commit will) 원칙 따르기

    • 어떤 파일을 수정했다 / 어떤 api를 사용했다 보다는 무엇을 왜 했는지로 작성

  • 제목 아래 빈 줄 하나

  • 본문

    • 작성시에는 - 을 활용

    • 필요하다면 레퍼런스 링크 첨부

 

2020/03/02 추가

https://blog.ull.im/engineering/2019/03/10/logs-on-git.html

ull.im

 

 

추가로 다짐하자면, git 커맨드가 언제 어디서나 자동으로 튀어나올 정도로 깃하기 ㅋㅋㅋ

 

 

 

 

 

 

 

https://woodforest.tistory.com/609에서 신승민 님의 발표를 듣고 메모한 내용 추가.

좋은 PR 작성

---

브랜치이름: 이름/날짜-기능명

코드리뷰 통과위해:
설계 리뷰 (문서공유, 관련코드 명시, 새로운 구조)   <- 이거 내가 최근에 비슷하게 했다! 생각보다 시간 많이걸렸다;

PR은 짧게 유지한다
-> 작업중에 보이는 추가작업은 별개의 PR로
-> 보일러 플레이트 생성 코드는 별도 브랜치로 날리고 해당 브랜치 베이스로 PR

PR 코멘트에 작업 의도 올리기
- Markdown 이용
- 코드 코멘트
- 기획 문서 / 디자인 링크 공유