Skip to content

Instantly share code, notes, and snippets.

@auaicn
Last active March 5, 2022 20:05
Show Gist options
  • Save auaicn/6048208a444783e8472d8f71b1ef6dab to your computer and use it in GitHub Desktop.
Save auaicn/6048208a444783e8472d8f71b1ef6dab to your computer and use it in GitHub Desktop.
Commit Rules for me

Issues on JIRA

Example

Commit Type: Title [Ticket]

  • contents
  • contents

Rules

  • title starts in CAPITALIZED CHARACTER
  • title in english.
  • contents in Korean (project by project, discuss with teammates).
  • contents, focus on what, why rather than how
  • variable, classes should be wrapped by `

Commit Types

  • Init 프로젝트 생성
  • Feat 새로운 기능 추가
  • Fix 버그 수정
  • Docs 문서 수정
  • Design 디자인 변경
  • Style 코드 formatting, 세미콜론(;) 누락, 코드 변경이 없는 경우
  • Refactor 코드 리팩토링
  • Test 테스트 코드, 리팩토링 테스트 코드 추가
  • Chore 빌드 업무 수정, 패키지 매니저 수정
  • Minor 사소한 변화
@auaicn
Copy link
Author

auaicn commented Mar 5, 2022

디렉터리 구조등을 바꾸는 경우에는 어떤 커밋타입을 사용하면 좋을까?

Refactor 를 사용하기에는, 코드변경은 없다보니 잘 어울리지 않는 듯 싶다.
Minor, Chore 등을 혼용해서 사용하고 있었는데, Chore 는 앞으로 디렉터리 위치 변경할때는 사용하지 않아야겠다.
패키지 매니저 수정등에만 사용해야겠음.

@auaicn
Copy link
Author

auaicn commented Mar 5, 2022

추가적으로, 첫번째 줄과 설명 사이에 빈 줄을 추가하도록 한다.

설명에 더해, 꼬리표를 추가해서 설명을 더 하는 경우가 있는데, 이 경우에도 사이에 빈 줄을 추가해주도록 한다. 참고

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment