Team PocketBand Commit Message Convention #8

enduf7686 · 2024-04-01T01:14:08Z

enduf7686
Apr 1, 2024
Maintainer

Commit Message Convention

Commit Message의 형식

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Commit Message의 각 줄은 읽기 쉽게 하기 위해서 100자를 넘지 않도록 한다.
Commit Message는 header, body, footer로 구성되며, 각각은 <BLANK LINE>으로 구분된다.

Message header

Commit Message의 첫번째 줄인 header는 변경에 대한 간결한 설명을 나타낸다.
header는 type, scope, subject로 구성된다.
<type>: 커밋의 종류
- <type>에 들어갈 수 있는 항목들
  - feat: 새로운 기능 추가
  - fix: 버그 수정
  - docs: 문서 관련
  - style: 스타일 변경 (포매팅 수정, 들여쓰기 추가, …)
  - refactor: 코드 리팩토링
  - test: 테스트 관련 코드
  - build: 빌드 관련 파일 수정
  - ci: CI 설정 파일 수정
  - perf: 성능 개선
  - chore: 그 외 자잘한 수정
<scope>: 변경된 부분에 대한 정보
- 에 들어갈 수 있는 항목들
  - 변경된 기능 단위
  - 변경된 클래스 혹은 메서드의 이름
  - etc…
<subject>: 변경에 대한 짧은 설명
- <subject>작성 시 주의할 점
  - 명령문, 현재 시제로 작성한다.
  - 첫 글자를 소문자로 작성한다.
  - 문장 마지막에 마침표를 붙이지 않는다.

Message body

body에는 변경의 이유와 변경 전후의 차이점과 관련된 내용이 들어가야 한다.
명령문, 현재 시제로 작성한다.

Message footer

footer에는 다음과 같은 내용이 들어가야 한다.
- 주요 변경 내역(Breaking Changes)
  - 변경점(description of the change)
  - 변경 사유(justification)
  - 마이그레이션 지침(migration instructions)
- 해결된 이슈(Referencing Issues)
  - 해결된 이슈는 커밋 메시지 하단에 Closes #<issue_number> 와 같이 기록되어야 한다.
    - Closes #234
  - 해결된 이슈가 여러 개인 경우는 다음과 같이 작성한다.
    - Closes #123, #245, #992

예시

**feat($compile): simplify isolate scope bindings**

Changed the isolate scope binding options to:
  - @attr - attribute binding (including interpolation)
  - =model - by-directional model binding
  - &expr - expression execution binding

This change simplifies the terminology as well as
number of choices available to the developer. It
also supports local name aliasing from the parent.

**BREAKING CHANGE**: isolate scope bindings definition has changed and
the inject option for the directive controller injection was removed.

To migrate the code follow the example below:

Before:

scope: {
  myAttr: 'attribute',
  myBind: 'bind',
  myExpression: 'expression',
  myEval: 'evaluate',
  myAccessor: 'accessor'
}

After:

scope: {
  myAttr: '@',
  myBind: '@',
  myExpression: '&',
  // myEval - usually not useful, but in cases where the expression is assignable, you can use '='
  myAccessor: '=' // in directive's template change myAccessor() to myAccessor
}

The removed `inject` wasn't generaly useful for directives so there should be no code using it.

**Closes #351**

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PocketBand

Team PocketBand Commit Message Convention #8

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Replies: 0 comments

Select a reply

Uh oh!

PocketBand

Team PocketBand Commit Message Convention #8

Uh oh!

Uh oh!

enduf7686 Apr 1, 2024 Maintainer

Commit Message Convention

Commit Message의 형식

Message header

Message body

Message footer

예시

Replies: 0 comments

enduf7686
Apr 1, 2024
Maintainer