Conventions

1. Git Convention

• Commit Message is written in English, and Issue / Pull Request / Wiki is written in both English and Korean.

1.1. Commit Message

• Commit message uses imperative tense.
• Articles are omitted.
• The following types of messages are highly recommended:
  • Fix : when a bug has been corrected.
  • Add : when additional features are added (codes, tests, examples, documents, etc.)
  • Remove : when a code is deleted.
  • Refactor : when the code's internal structure is modified without altering its external behavior. (no bug fixes or added features)
  • Modify : when changes other than above are made
• For other types, refer to the English dictionary for commit message.

1.2. Issue / Pull Request

• Issue titles focus on Problems. (ex. conflict)
• PR titles focus on Solutions. (ex. Subfile generation)
• Reviewer Approved PR is merged by the author.

1.3. Code Review

• A code cannot be merged without being reviewed.
• Four approvals are required for the merge.

1.4. Kanban Board

All the tasks are managed in the Kanban Board.

• To do : New Issue.
• In Progress : Issue resolution in progress. (writing code, etc.)
  • Bring a new issue card to share the work status with the team members.
• Review In Progress : Pull request waiting for approvals.
• Reviewer Approved : Approved and waiting to be merged.
• Done : Merge completed and issues resolved

1.5. Branch

• Branch names are in the form of Function/42login. (ex. readme/taelee)
• Branch names begin with lowercase letters.

2. Code Convention

• (To be discussed)

---

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 할 수 없다.
• 코드리뷰는 4명에게 받는 것을 원칙으로 한다.

1.4. Kanban Board

모든 프로젝트 진행 상황은 칸반보드로 관리한다.

• To do : 신규 이슈
• In Progress : 이슈 해결 진행 중
  • 작업을 시작한 이슈 카드는 이곳으로 직접 옮겨 작업현황을 팀원들과 공유한다.
• Review In Progress : PR 신청 및 대기중
• Reviewer Approved : 리뷰어 승인 및 merge 대기중
• Done : merge 완료 및 이슈 해결

1.5. Branch

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

2. Code Convention

• (작성 예정)