Convention - f-lab-edu/home-delivery GitHub Wiki
협업으로 진행되는 프로젝트이기 때문에 소통을 위해 Convetion 을 정의하여 최대한 통일되게 코드를 작성하고 진행될 수 있도록 했습니다
커밋구분 | 설명 |
---|---|
Feat | (feature)개선 또는 기능 추가 |
Bug | (Bug Fix)버그 수정 |
Doc | (Documentation)문서 작업 |
Test | (Test)테스트 추가/수정 |
Bld | (Build)빌드 프로세스 관련 수정(yml) |
Perf | (Performance)속도 개선 |
Refactor | (Refactoring) 코드 정리 / 리팩토링 |
- Google code Style을 준수
- STS Check Style 플러그인을 적용하여 코드 컨벤션을 유지
- Commit 전 Check Style로 확인 후 Commit
- Git-flow 를 사용하여 브랜치를 관리
- 기능 구현시 develop 에서 flow 를 시작하여 feature 브랜치를 만들고 기능 구현이 끝나면 PR 및 리뷰 후 merge
- master : 제품으로 출시될 수 있는 브랜치
- develop : 다음 출시 버전을 개발하는 브랜치
- feature : 기능을 개발하는 브랜치
- release : 이번 출시 버전을 준비하는 브랜치
- hotfix : 출시 버전에서 발생한 버그를 수정 하는 브랜치
참고 : 우아한형제들 기술블로그
- PR 생성시
[#이슈번호] 제목
에 맞춰서 생성 - 내용은
작업 내용
과다음 예정 작업
에 맞춰 작성 - PR시 반드시
1명
이상의 리뷰어에게 리뷰를 받고 피드백을 반영하여 리팩토링 후 merge - merge 방식은 merge 후 깔끔한 커밋 내역을 위해
squash and merge
을 사용