GitHub 규칙

Project

칸반보드 양식

Status	작업 설명
No Status	아직 할당되지 않은 작업
Todo	할당이 정해진 할 작업
In Progress	진행중인 작업
In Review	작업이 끝나고 PR 리뷰를 기다리는 작업
Merged	Merge 완료된 작업

Issue

Issue 규칙

• 제목만 작성합니다.
• pr 단위와 동일합니다.

Branch

Branch 전략

브랜치명	설명
main	배포를 위한 브랜치
develop	개발을 위한 브랜치
feature	이슈단위 기능 작성을 위한 브랜치
hotfix	급한 이슈가 생겼을 시 문제를 해결하는 브랜치
refactor	코드를 리팩토링하는 브랜치

Branch 명명

feat/#이슈번호-기능명(길어지면 스네이크케이스)

ex) feat/#11-button-test

PR

pr 템플릿

⚙️ PR 타입

 Feature
 Hotfix

✨ 기능 설명 or 🚨 문제 상황
👨‍💻 구현 내용 or 👍 해결 내용


🎯 PR 포인트

📝 참고 사항

❓ 궁금한 점

pr 규칙

• label로 pr 우선순위를 구분합니다.
  • D-n 룰
• 1명의 approve를 받아야 merge할 수 있습니다.

pr 단위

• 페이지 하나는 너무 크다.
• 300줄 미만으로 작성합니다.
  • mock 데이터 제외

코드 리뷰 작성 전 참고하기

효과적인 코드 리뷰를 위해서

공통시스템개발팀 코드 리뷰 문화 개선 이야기 | 우아한형제들 기술블로그

코드 리뷰 in 뱅크샐러드 개발 문화 | 뱅크샐러드

Merge

Merge 전략

• feature → develop : squash & merge
• hotfix → develop : squash & merge
• refactor → develop : rebase & merge
• develop → main : rebase & merge

Label

• 긴급, 기능, 버그, 리팩토링
• D-n 룰

  • 긴급한 수정사항으로 바로 리뷰해 주세요. 앱의 오류로 인해 장애가 발생하거나, 빌드가 되지 않는 등 긴급 이슈가 발생할 때 사용합니다.

  • D-N (Within N days)

    “Working Day 기준으로 N일 이내에 리뷰해 주세요”

Commit

Commit 컨벤션

feat: #1 xxx 기능 추가
fix: #2 xxx 기능 수정
docs: #3 xxx 문서 수정
style: #4 xxx 코드 수정
refactor: #5 xxx 기능 수정
chore: #6 xxx 버전 수정
design: #7 xxx 페이지 수정

Commit 단위

1 commit 1 action을 지향합니다. 최대한 작은 단위로 커밋하려고 노력합시다.