커밋 메시지
명확한 커밋 메시지를 사용하면 풀 요청을 더 쉽게 검토하고 출시 노트를 더 쉽게 생성할 수 있습니다. Blockly 프로젝트에서는 이를 지원하기 위해 컨벤셔널 커밋을 사용합니다.
각 커밋은 다음 형식을 따라야 합니다.
<type>: <description>
[optional body]
[optional footer(s)]
핵심 Blockly 저장소에는 이를 적용하는 데 도움이 되는 커밋 린터가 있습니다. 풀 요청에 커밋이 여러 개 있는 경우 린터가 제목을 확인합니다. 커밋이 하나인 경우 해당 커밋을 확인합니다. 개별 커밋과 풀 요청 제목 모두 이 가이드라인을 따르는 것이 좋습니다.
유형
유형은 비어 있지 않아야 하며 모두 소문자여야 합니다. 다음은 허용되는 유형의 목록입니다.
chore- 종속 항목 업그레이드와 같은 일상적인/자동화된 작업을 완료하는 커밋
deprecate- 기능을 지원 중단하는 커밋
feat- Blockly에 새로운 기능을 추가하는 커밋
fix- Blockly의 버그/오류를 수정하는 커밋
release- 새 버전 출시와 관련된 커밋
브레이킹 체인지
호환성이 깨지는 변경사항을 적용하는 커밋은 커밋 유형 뒤에 !를 추가해야 합니다. 브레이킹 체인지는 앱에서 Blockly를 사용하는 개발자에게 영향을 미쳐 추가 작업을 해야 할 수 있는 변경사항입니다.
예:
none
fix!: return type of workspace.paste
호환성이 깨지는 변경사항은 위의 유효한 유형 중 하나일 수 있습니다.
설명
설명은 비어 있지 않아야 하며 256자(영문 기준) 미만이어야 합니다.
본문
본문은 선택사항입니다. 제공된 경우 이 항목과 설명 사이에 빈 줄이 있어야 합니다. 256자(영문 기준) 이하의 여러 줄로 나누어야 합니다.
일반적으로 이러한 종류의 정보는 커밋에 직접 넣는 것보다 풀 요청 설명에 넣는 것이 좋습니다.
바닥글
바닥글은 선택사항입니다. 제공된 경우 제목과 본문 사이에 빈 줄이 있어야 합니다. 256자(영문 기준) 이하의 여러 줄로 나누어야 합니다.
비관례적인 커밋 수정
수정사항을 적용할 때 컨벤셔널 커밋을 사용하지 않은 경우 커밋 수에 따라 메시지를 수정하는 두 가지 옵션이 있습니다.
풀 요청에 커밋이 여러 개 있는 경우 요구사항에 맞게 풀 요청 제목을 수정합니다. 풀 요청이 병합되면 제목이 커밋 메시지가 되도록 다른 커밋이 스쿼시됩니다.
풀 요청에 커밋이 하나 있는 경우
git commit --amend를 사용하여 커밋 메시지를 수정하고 변경사항을 Blockly 포크에 강제 푸시합니다. 이렇게 하면 이 브랜치와 연결된 열린 풀 요청이 자동으로 업데이트됩니다.git push --force origin my-branch.