🔔 Wypl Backend Repository Convention

[KIMSEI1124]

🔔 Repository Convention

해당 저장소의 컨벤션을 정리하였습니다.
기여하기 전에 반드시 컨벤션을 확인하시고 따라주시면 감사합니다.

1. Branch

해당 저장소에서는 git flow전략을 참고하여 사용하고 있습니다.

main : 제품으로 출시될 수 있는 브랜치
dev : 다음 출시 버전을 개발하는 브랜치
feat : 기능을 개발하는 브랜치
release : 이번 출시 버전을 준비하는 브랜치
hotfix : 출시 버전에서 발생한 버그를 수정 하는 브랜치

1.1. feat 브랜치 네이밍 전략

기능 개발을 하기 위한 브랜치의 네이밍은 이슈 번호와 함께 작성합니다.

feat/{Issue Number}

실제로 작성하는 방법은 다음과 같습니다.

feat/#1

이후 PR을 요청할때는 기본적으로는 dev에다가 요청을 합니다.

2. Code

코드 컨벤션은 캠퍼스 핵데이 Java 코딩 컨벤션 v1.2를 따릅니다.
인텔리제이 사용자는 다음을 확인하시고 코드 컨벤션을 적용시켜주시면 감사합니다.

3. Commit

커밋 컨벤션은 기본적으로 udacity를 따라갑니다.

4개의 부분으로 나뉘며 아래와 같습니다.

1. The Type
2. The Subject
3. The Body
4. The Footer

자세한 부분은 위의 udacity 혹은 관련 레퍼런스 참조를 부탁드립니다.

커밋을 작성할때는 다음과 같습니다.

{The Type}({Issue Number}): {The Subject}

{The Body}

{The Footer}

실제로 작성한 커밋은 다음과 같습니다.

Feat(#1): 멀티 모듈 프로젝트 생성

어플레케이션 모듈 생성
도메인 모듈 생성

Reolvers: #1

주의할 점은 The Type 부분의 첫 문자는 영어 대문자입니다.

더 많은 Type 확인하기

• feat: 새로운 기능 추가
• fix: 버그 수정
• docs: 문서 수정
• style: 코드 스타일 변경 (코드 포매팅, 세미콜론 누락 등)
• design: 사용자 UI 디자인 변경 (CSS 등)
• test: 테스트 코드, 리팩토링 (Test Code)
• refactor: 리팩토링 (Production Code)
• build: 빌드 파일 수정
• ci: CI 설정 파일 수정
• perf: 성능 개선
• chore: 자잘한 수정이나 빌드 업데이트
• rename: 파일 혹은 폴더명을 수정만 한 경우
• remove: 파일을 삭제만 한 경우

Ref

1. 우아한 기술블로그 - 우린 Git-flow를 사용하고 있어요
2. 캠퍼스 핵데이 Java 코딩 컨벤션
3. Udacity Git Commit Message Style Guide