Skip to content

협업 컨벤션

Gwonwoo-Nam edited this page Aug 8, 2023 · 1 revision

🤝 그라운드 룰

  • 무엇인가 부탁할 때 용용체를 씁시다. 🥳
  • 칭찬하는 분위기 ☺️
  • 회의를 진행하게 되면, 회의록에 정리합니다. ✏️

의사결정

  • 모두 발언했는지 확인하고, 다음 의제로 넘어갑니다.

📜 브랜치 룰

Prefix

feature/ : 기능 개발 작업과 관련된 브랜치를 의미합니다.

fix/ : 버그 수정 작업과 관련된 브랜치를 의미합니다.

refactor/ : 코드 품질 개선 작업과 관련된 브랜치를 의미합니다.

release/ : 배포 작업과 관련된 브랜치를 의미합니다.

Suffix

이슈번호 #000 + 기능 명

브랜치 예제

feature/#1-header

🔖 Pull Request Rule

  1. 레포지토리 및 PR 전략은 Git Flows를 기반으로 합니다.
  2. 만장일치 Merge : 나를 제외한 나머지 2명에게 Review & Approve를 받아야 머지됩니다.
  3. Squash Merge : PR 승인 시 스쿼시 머지로 핵심 커밋만 남깁니다.
  4. Branch Protection : dev, release-dev, release-production 등 핵심 브랜치에 직접 push는 제한됩니다.
  5. PR Testing : 배포 관련 브랜치(release-dev, release-production)의 PR은 Github Actions의 테스트가 통과되어야 합니다.
  6. Test & Code Coverage : 기능과 단위 테스트 코드를 함께 PR합니다. 평균적인 Code Coverage가 70% 이상을 유지하도록 합니다.

⌨️ Coding Convention

  1. 기본적으로 캠퍼스 핵데이 코딩 컨벤션을 따릅니다
  2. 메서드의 첫 줄은 반드시 개행 문자가 옵니다.
  3. 어노테이션은 길이 순서로 정렬하고, 길이가 같은 경우 사전 순서로 정렬합니다.