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