Skip to content

Latest commit

 

History

History
75 lines (58 loc) · 1.96 KB

convention.md

File metadata and controls

75 lines (58 loc) · 1.96 KB

깃랩 이슈 기준 vs 지라 기준

branch 컨벤션

  • {지라 에픽}/{태그}/{#이슈넘버}
    • 예) BE-Community/feat/#1

jira컨벤션

  • 에픽 : {BE|FE|INFRA}-{도메인|페이지|컴포넌트}
  • 스토리 : 서술형
  • 태스크 : 짧게 서술

commit 컨벤션

{태그}: {커밋 제목} #{이슈 넘버} 
  • feat: 새로운 기능 추가
  • fix: 버그수정
  • docs: 문서수정
  • style: 코드 포매팅 등
  • refactor: 코드 리팩토링
  • chore: 기타 작업
  • test : 테스트 코드, 리펙토링 테스트 코드 추가

PR 컨벤션

제목 : [에픽] {태그}: {기능 타이틀} (#이슈번호)

템플릿

**개요**
 - 개요 내용을 작성해주세요.

**타입**
- [ ] feat: 새로운 기능 추가
- [ ] fix: 버그 수정
- [ ] chore: 빌드 업무 수정, 패키지 매니저 수정
- [ ] refactor: 코드 리펙토링
- [ ] style: 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
- [ ] docs: 문서 수정
- [ ] test: 테스트 코드, 리펙토링 테스트 코드 추가

** 작업 내용**
- Issue Number: #n
- 작업 내용에 대해 작성해주세요.
- screenshot을 포함할 수 있다면 추가해주세요.

### 꼬릿말(Footer)
- 꼬리말은 선택사항, 이슈 트래커 ID 작성
- "유형: #이슈 번호" 형식으로 사용
- 여러 개의 이슈 번호를 적을 때는 쉼표(,)로 구분
- 이슈 트래커 유형은 다음 중 하나를 사용
1. Fixes: 이슈 수정중 (아직 해결되지 않은 경우)
2. Resolves: 이슈를 해결했을 때 사용
3. Ref: 참고할 이슈가 있을 때 사용
4. Related to: 해당 커밋에 관련된 이슈번호 (아직 해결되지 않은 경우)
ex) Fixes: #45 Related to: #34, #23 

Gitlab issue 컨벤션

## Description ✏
- 페이지/컴포넌트를 구현합니다 or 기능/API를 구현합니다

## Todo 📝
- [ ] todo1
- [ ] todo2

## ETC 📌
- 남길 말을 적어주세요.