Skip to content
This repository was archived by the owner on Jan 28, 2023. It is now read-only.

Ground Rule

Choi Byunghyeon edited this page Mar 15, 2022 · 8 revisions

image

Git 전략

  • sub branch 이름은 대문자의 issue번호와 같습니다. ISSUE-12 ISSUE-19
  • 모든 머지는 PR이 필요합니다. (protectio 예정)
    • 모든 PR은 최소 1명의 approve가 필요합니다.
    • 가능하면 멘토+멘티 모두 approve받기를 권장합니다.

Commit Convention

// example
#12 회원 가입 개발
#19 스트리머 등록 개발
#21 스트리머 해지 개발

README 수정
회원 가입 시퀀스 다이어그램 수정
  • 제목에 issue 번호를 #을 붙여 prefix로 작성합니다.
  • 본문은 사용하지 않습니다.
  • feature, refactor, chore 등의 prefix는 사용하지 않습니다.
    • 대부분 issue 단위로 작업되며, issue 조차 필요없을 정도로 작은 작업은 prefix 없이 commit 합니다.

PR review

  1. 1명 이상의 approve가 있어야만 머지 가능합니다.
    • 하지만 학습을 위해 모든 conversation이 resolve되고, 2명 모두의 approve 후 merge를 권장합니다.
    • main branch protection이 걸려있습니다.
  2. 각 conversation은 마지막 comment에 리뷰어가 👍 를 담으로서 완결됩니다.
    • PR 작성자는 이를 확인하고 코드 수정이 필요하다면 수정 후 resolve 합니다.
  3. 👀 가 달린 comment는 멘토님의 의견을 요청하는 것으로 resolve하지 않습니다.
    • 멘토님을 태그하는 것을 권장합니다.
  4. 필수적이지 않은 수정 및 정보성 코멘트는 Nit를 prefix로서 추가합니다.
    • 리뷰어들은 항상 무엇인가 더 나은 방법이 있을 수 있다는 의견을 자유롭게 남길 수 있어야 합니다.
      그러나 그것이 그다지 중요하지 않다면 Nit와 같은 접두어를 붙여 코드 작성자가 선택할 수 있도록 해야 합니다.
Clone this wiki locally