Skip to content

Latest commit

 

History

History
152 lines (100 loc) · 4.54 KB

CONTRIBUTING.md

File metadata and controls

152 lines (100 loc) · 4.54 KB
Raw

🏄‍♂️ 마루 백엔드 기여 도움말

이 레포지토리에 기여하기 위해서 다음 지침을 따라야 합니다.


버그를 찾았나요?

이슈를 통해 버그를 보고해주세요.

혹은 직접 버그를 고쳐 Pull Request를 보내주세요.


새로운 기능이 필요한가요?

이슈를 통해 새로운 기능을 제안해주세요.

혹은 직접 기능을 개발해 Pull Request를 보내주세요.


질문이 있나요?

이슈를 통해 질문해주세요.


Pull Request

제공되는 Pull Request 템플릿에 따라 상세히 작성해주세요.


Branch

브랜치 이름은 다음과 같은 형식을 따릅니다.

<유형>/#<이슈 번호>-<짧은 요약>

유형

유형 설명
build 빌드 시스템 또는 외부 종속성에 영향을 주는 변경 사항 (예: gradle, npm)
ci CI 구성 파일 및 스크립트에 대한 변경 사항 (예: Github Actions, CLOUDTYPE)
docs 문서 변경 사항 (예: README, API 문서)
feat 새로운 기능 추가
fix 버그 수정
perf 성능 개선
refactor 버그를 수정하거나 기능을 추가하지 않은 코드 리팩토링
test 누락된 테스트 추가 또는 기존 테스트 수정

Commit Message

Angular Commit Message Format을 따릅니다.

다음 명령어를 사용하면 커밋 템플릿을 통해 커밋 메시지를 작성할 수 있습니다.

git commit

형식

커밋 메시지는 머리글, 본문, 바닥글로 구성됩니다.

<머리글>
<!-- 빈 줄 -->
<본문>
<!-- 빈 줄 -->
<바닥글>

머리글

필수입니다.

<유형>(<범위>): <짧은 요약>
  │    │         │
  │    │         └─⫸ 현재, 명령형으로 작성. 마침표 금지.
  │    │
  │    └─⫸ 커밋 범위: 이슈 번호|파일 이름|빈 값|...
  │
  └─⫸ 커밋 유형: build|ci|docs|feat|fix|perf|refactor|test

유형

브랜치 이름 지을 때의 유형과 동일합니다.

유형 설명
build 빌드 시스템 또는 외부 종속성에 영향을 주는 변경 사항 (예: gradle, npm)
ci CI 구성 파일 및 스크립트에 대한 변경 사항 (예: Github Actions, CLOUDTYPE)
docs 문서 변경 사항 (예: README, API 문서)
feat 새로운 기능 추가
fix 버그 수정
perf 성능 개선
refactor 버그를 수정하거나 기능을 추가하지 않은 코드 리팩토링
test 누락된 테스트 추가 또는 기존 테스트 수정

범위

선택 사항입니다.

관련된 이슈 번호나 파일이름을 작성합니다.

요약

변경사항이 "무엇"인지 작성합니다.

  • 명령형, 현재 시제 사용: "변경함", "변경했음"이 아닌 "변경"으로 작성
  • 끝에 마침표(.) 금지
  • 한글 사용 권장
  • 50자 이내로 작성

본문

docs 유형의 커밋을 제외하고 필수로 작성해야 합니다.

  • 한글 사용 권장
  • 한 줄에 72자가 넘지 않도록 주의
  • 어떻게 보다는 "무엇"을 "왜" 변경했는지 작성
  • 자유로운 형식으로 작성

바닥글

선택 사항입니다.

참고 사항이나 추가로 할 말이 있을 떄 작성합니다.


코드 컨벤션

Google Java Style Guide를 따릅니다.