Git Convention

1. Git Convention

• Commit Message는 영문으로, Issue / Pull Request / Wiki는 한글로 작성한다.

1.1. Commit Message

• 명령문 형식으로 적는다.
• 관사는 생략한다.
• 되도록 다음 동사만 사용한다.
  • Fix : 올바르지 않은 동작을 고친 경우에 사용한다.
  • Add : 코드나 테스트, 예제, 문서 등의 추가가 있을 때 사용한다.
  • Remove : 코드의 삭제가 있을 때 사용한다.
  • Refactor : 전면 수정이 있을 때 사용한다.
  • Modify : 상기 수정사항 이외의 수정이 있을 때 사용한다.
• 이것 외 메세지는 commit message 영어사전을 참고하여 작성한다.

1.2. Issue / Pull Request

• 이슈는 문제점 위주로 제목을 작성한다. (ex. 충돌 발생)
• PR은 해결방안 위주로 제목을 작성한다. (ex. 서브파일 생성)
• Reviewer Approved 된 PR은 작성자가 merge 한다.

1.3. Code Review

• 리뷰를 받지 않은 코드는 master에 merge 할 수 없다.
• 코드리뷰는 2명에게 받는 것을 원칙으로 한다.

1.4. Branch

• 브랜치 이름은 기능/이름 으로 설정한다. (ex. readme/daehyun)
• 소문자로 시작한다.

2. Code Convention

• (작성 예정)