Git에서 분기 및 커밋 이름 지정을 위한 단순화된 규칙

git 브랜치 및 커밋에 관한 많은 훌륭한 명명 규칙이 있습니다.
하지만 매우 간결하고 단순한 것을 원한다면 어떻게 해야 할까요?
여기에 제안이 있습니다.

지점 명명 규칙

이 기사는 훌륭한 기반입니다.
그러나 훨씬 더 단순화할 수 있습니다.

범주
git 브랜치는 카테고리로 시작해야 합니다. feature , bugfix , hotfix 또는 test 중 하나를 선택합니다.

feature는 기능

을 추가, 리팩터링 또는 제거하기 위한 것입니다.

bugfix는 버그

를 수정하기 위한 것입니다.

hotfix는 임시 솔루션으로 및/또는 일반적인 프로세스를 따르지 않고 코드를 변경하기 위한 것입니다(일반적으로 긴급 상황 때문에)

.

test는 문제/티켓

이외의 실험용입니다.

참조
범주 다음에는 "/ "다음에 작업 중인 문제/티켓에 대한 참조가 있어야 합니다. 참조가 없으면 no-ref 를 추가하십시오.

설명
참조 뒤에 또 다른 "/ "가 있어야 하며 그 뒤에 이 특정 분기의 목적을 요약하는 설명이 있어야 합니다. 이 설명은 짧고 "케밥 케이스"여야 합니다.
기본적으로 작업 중인 이슈/티켓의 제목을 사용할 수 있습니다. 특수 문자를 "- "로 바꾸십시오.

요약하면 분기할 때 다음 패턴을 따릅니다.

git branch <category/reference/description-in-kebab-case>

예:

기능을 추가, 리팩터링 또는 제거해야 합니다.git branch feature/issue-42/create-new-button-component

다음 버그를 수정해야 합니다.git branch bugfix/issue-342/button-overlap-form-on-mobile

버그를 매우 빠르게 수정해야 합니다(아마도 임시 솔루션 사용).git branch hotfix/no-ref/registration-form-not-working

문제/티켓 외부에서 실험해야 합니다.git branch test/no-ref/refactor-components-with-atomic-design

커밋 명명 규칙

커밋의 경우 AngularCommit Message Guideline 및 Conventional Commits 지침을 결합하고 단순화할 수 있습니다.

범주
커밋 메시지는 변경 범주로 시작해야 합니다. feat , fix , refactor 및 chore 의 4가지 범주를 거의 모든 항목에 사용할 수 있습니다.

feat는 새로운 기능

을 추가하기 위한 것입니다.

fix는 버그

를 수정하기 위한 것입니다.

refactor는 성능 또는 편의 목적(예: 가독성)을 위해 코드를 변경하기 위한 것입니다

.

chore는 다른 모든 것(문서 작성, 서식 지정, 테스트 추가, 쓸모 없는 코드 정리 등)을 위한 것입니다

.

범주 다음에 커밋 설명을 알리는 ": "가 있어야 합니다.

진술
콜론 다음에 커밋 설명은 변경 사항을 설명하는 짧은 문장으로 구성되어야 합니다.
각 문은 명령형으로 결합된 동사로 시작해야 합니다. 명령문은 "; "로 구분되어야 합니다.

요약하면 커밋할 때 다음 패턴을 따릅니다.

git commit -m '<category: do something; do some other things>'

예:

git commit -m 'feat: add new button component; add new button components to templates'

git commit -m 'fix: add the stop directive to button component to prevent propagation'

git commit -m 'refactor: rewrite button component in TypeScript'

git commit -m 'chore: write button documentation'

참조

출처

기사:

기사:Conventional Commits 1.0.0

기사:Commit Message Guideline

기사:A Successful Git Branching Model