Project Convention

이 문서는 프로젝트의 전반적인 컨벤션을 다룹니다.

Commit Convention

양식

<type>: <subject> - <issue number>

• type : 어떤 의도의 커밋인지를 나타냅니다.
• subject : 커밋의 제목입니다. 50자를 넘기지 않도록 합니다.
• issue number : 레포지토리의 이슈 탭에 해당하는 이슈 번호를 적습니다. 이슈 번호가 없다면 생략합니다.

Type

• feat : 기능, 새로운 기능을 추가하거나 구현하였을 때에 사용합니다.
• fix : 버그, 버그 수정을 했을 때에 사용합니다.
• refactor : 리팩터링, 코드의 리팩터링을 했을 때에 사용합니다.
• comment : 필요한 주석 추가 및 변경, 코드의 주석을 추가하거나 변경했을 때에 사용합니다.
• docs : 문서를 수정한 경우, 문서를 추가, 수정, 삭제했을 때에 사용합니다.
• test : 테스트 코드, 테스트 코드를 추가하거나 수정, 삭제했을 때에 사용합니다.
• chore : 기타 변경사항, 빌드 스크립트 수정, 패키지 매니저 수정 등 기타 변경사항을 했을 때에 사용합니다.

예시

feat: 게시글 작성 API 구현

fix: 게시글 수정 API에서 게시글이 수정되지 않는 버그 수정

refactor: 게시글 수정 API에서 게시글 수정 로직 리팩터링

comment: 게시글 수정 API에서 게시글 수정 로직 주석 추가

docs: README.md 수정

test: 게시글 작성 API 테스트 코드 작성

chore: .gitignore 수정

Pull Request 컨벤션

[<type>] <subject> - <issue number>

• type : 어떤 의도의 PR인지를 나타냅니다.

• subject : PR의 제목입니다. 50자를 넘기지 않도록 합니다.

• issue number : 레포지토리에 이슈탭에 올라온 PR과 관련된 이슈 번호, 이슈 번호가 없다면 생략합니다.

• Description : PR의 내용을 자세히 적습니다. 어떤 이유로 PR을 했는지, 어떤 코드를 수정했는지 등을 적습니다. 이슈 번호가 있다면 이슈 번호를 적고 태깅을 합니다.

Type

• FEAT : 기능, 새로운 기능을 추가하거나 구현하였을 때에 사용합니다.
• FIX : 버그, 버그 수정을 했을 때에 사용합니다.
• REFACTOR : 리팩터링, 코드의 리팩터링을 했을 때에 사용합니다.
• COMMENT : 필요한 주석 추가 및 변경, 코드의 주석을 추가하거나 변경했을 때에 사용합니다.
• DOCS : 문서를 수정한 경우, 문서를 추가, 수정, 삭제했을 때에 사용합니다.
• TEST : 테스트 코드, 테스트 코드를 추가하거나 수정, 삭제했을 때에 사용합니다.
• CHORE : 기타 변경사항, 빌드 스크립트 수정, 패키지 매니저 수정 등 기타 변경사항을 했을 때에 사용합니다.

예시

[FEAT] 게시글 작성 API 구현 - #1
[FIX] 게시글 수정 API에서 게시글이 수정되지 않는 버그 수정 - #2
[REFACTOR] 게시글 수정 API에서 게시글 수정 로직 리팩터링 - #3
[COMMENT] 게시글 수정 API에서 게시글 수정 로직 주석 추가 - #4
[DOCS] README.md 수정 - #5
[TEST] 게시글 작성 API 테스트 코드 작성 - #6
[CHORE] .gitignore 수정 - #7