-
Notifications
You must be signed in to change notification settings - Fork 2
Git Convention
- 손유진 (merge 관리자)
- 박태근 (일반 작업자)
- 발행 기준: 기능 단위 (ex. 로그인, 목표 추가하기)
- 이슈 내용: 기능 구현이 완료되기 위해 구현해야할 내용을 간략하게 구현상세 로 작성
이슈 작성 예시
[USER] 로그인 기능 구현,[USER] 로그인 기능 서버 연결,[GOAL] 목표 생성하기 기능 구현... 등 관련된 주제를[]내에 작성하고, 간략한 구현 사항을 제목으로 작성내용은 각 기능을 구현하기 위해 필요한 작업에 대해 작성
master: 실제 배포 브랜치(상시유지)
dev: 개발용 브랜치(상시유지)
- 생성 기준: 발행한 이슈 단위
- 브랜치 명 네이밍 규칙: 축약어, 고유명사인 경우를 제외하고 소문자로 작성
페이지 브랜치명 작성 예시
기본 구조
feat/[발행한 이슈 번호]-[분업 단위 내용]작성 예시
feat/1-login
커밋 메세지 작성 예시
기본 구조
[작업 타입] : [작업 내용]작성 예시
FEAT: add main page view
FIX: modify main page list style
FEAT: 새로운 기능의 추가
FIX: 버그 수정
DOCS: 문서 수정
STYLE: 스타일 관련 기능(코드 포맷팅, 세미콜론 누락, 코드 자체의 변경이 없는 경우)
REFACTOR: 코드 리펙토링
TEST: 테스트 코트, 리펙토링 테스트 코드 추가
CHORE: 빌드 업무 수정, 패키지 매니저 수정(ex .gitignore 수정 같은 경우)
add [추가된 기능]: 기능 추가 (ex. add search bar)
modify [개선된 기능]: 기능 개선
fix [수정된 기능]: 기능 버그 수정
delete [삭제된 기능]: 기능 삭제
제목
[기능] 구현 (#이슈번호)
내용
구현 상세: 새롭게 추가된 파일에 대한 설명을 작성합니다.
변경 사항: 새롭게 추가된 기능으로 인해 변경된 파일에 대한 설명을 작성합니다.
제목
[기능] 수정 (#이슈번호)
내용
변경 전: 기능 변경 전의 동작에 대해 작성합니다.
변경 후: 변경한 부분에 대한 설명과 수정 후 동작 결과를 작성합니다.
제목
[기능] 수정 (#이슈번호)
내용
변경 전: 기능 수정 전의 문제 상황에 대한 설명과 원인을 작성합니다.
변경 후: 수정한 부분에 대한 설명과 수정 후 동작 결과를 작성합니다.
제목
[기능] 삭제 (#이슈번호)
내용
변경 전: 기능 삭제 전의 문제 상황에 대한 설명과 원인을 작성합니다.
변경 후: 삭제한 부분에 대한 설명과 수정 후 동작 결과를 작성합니다.
TODO 박스에 작업이 추가됩니다.
In Progress 박스에 작업을 이동시킵니다.
Done 박스에 작업을 이동시킵니다.
동료들에게 코드 리뷰를 요청하고, 리뷰 완료 시, dev 브랜치에 병합 합니다.
머지된 dev 브랜치에서 기능을 테스트합니다.
dev 브랜치에서 문제가 없었다면 master 브랜치에 병합 합니다.
Merged 박스에 작업을 이동시킵니다.