Code Place 팀의 Convention

Git Convention

CSEP팀의 Workflow를 위한 컨벤션입니다.

Branch

브랜치 종류

• main: 운영 브랜치
• develop: 개발용 브랜치
• feature: 기능 개발 및 이슈 사항 해결이 필요할 때, develop 브랜치에서 분기되는 브랜치
  • #{이슈번호}-할일-설명: 새로운 기능을 개발하는 브랜치

참고

• 브랜치의 할일설명은 최대한 구체적으로 작성해주세요.
• 또한 한글로 작성해주세요.
• 이슈번호를 제외한 브랜치 명의 공백은 하이픈(-)으로 처리합니다.

예시

• #31-회원가입-Fixtures-추가
• #102-마이페이지-도전과제

Commit

규칙

• 어느 커밋으로 checkout하더라도 프로젝트가 정상적으로 동작할 수 있도록 커밋을 작성해야 합니다.
• 커밋은 최대한 작은 단위로 나누어 작성해야 합니다.
• 커밋 메세지는 다음과 같은 형식을 따라야 합니다.

#이슈번호 <타입>: <제목>

[본문] (선택)

• 타입은 가급적 소문자로 작성합니다.

예시

feat : 드롭다운 구현

작성된 드롭다운 사용법은 코드의 주석을 참고하세요.

타입

• feat: 기능 개발 및 기존에 존재했던 기능 변경
• fix: 버그 수정
• docs: 문서 수정(README 등)
• design: 페이지의 스타일 관련
• assets: 새로운 디자인 파일 수정 및 추가(이미지 및 정적 파일)
• refact: 코드 리팩토링
• chore: 빌드 업무 수정, 패키지 매니저 수정, 기타 등등
• test: 테스트 코드 작성 및 수정

커밋 메시지 컨벤션

Issue

Issue 제목

• 작업 내용에 맞추어 제목 앞에 태그를 답니다.
• [FEAT] : 기능 개발 및 기능 변경
• [DESIGN] : 디자인 개선
• [CHORE] : 빌드 업무 수정 및 기타 등등
• [REFACT] : 기능엔 영향이 없는 코드 리팩토링
• [DOCS] : README 작성 등
• [BUGFIX]: 버그 수정

Issue Template

• **TODO**(필수): 해야할 일을 작성합니다.
• 요청사항(부분 필수): 본인이 아닌 다른 Assignee를 지정할 때 요청사항을 명확하게 작성합니다.
• 제약사항(선택): 해야하는 일 중 제약사항이 있다면 작성합니다.
• 참고사항(선택): 본인이 아닌 다른 Assignee를 지정할 때, 참고사항(파일위치 등)을 작성합니다.

Issue Label

• frontend-client: 프론트엔드(클라이언트) 페이지와 관련된 일에 지정합니다.
• frontend-admin: 프론트엔드(어드민) 페이지와 관련된 일에 지정합니다.
• backend: 일반적인 백엔드에서 처리하는 일에 지정합니다.
• backend-infra: 백엔드 배포와 관련된 일에 지정합니다.
• documentation: 문서 작성 시 지정합니다.
• bug: 버그와 관련된 일에 지정합니다.
• urgent: 긴급하게 처리해야 하는 일에 지정합니다.

Issue 등록 시 참고사항

• Asignee를 반드시 등록해주세요(필수).
• Issue 기본적으로 UnOrdered List로 작성합니다(필수).
• 프로젝트를 등록해주세요(필수).
• Issue Label을 등록해주세요(권장).