기존 커밋: 커밋을 작성하는 더 좋은 방법 git 메시지

소개

Git에 대한 연구에서 나는 커밋 정교화에서 if to 방향에 대한 표준이 존재하는지 의심했습니다.
나는 읽을 수 있는 커밋 기록을 유지하고 나와 내 코드에 액세스할 수 있는 다른 사람들을 위한 시설을 전송하기 위해 찾고 있었습니다.
그래서 저는 Conventional Commits와 연락을 취하고 이 사양을 공부하면서 배운 내용을 쓰기로 결정했습니다.

기존 커밋에 대해 자세히 알아보기

기존 커밋에 대한 간단한 정의는 커밋 메시지에서 사용할 규칙을 정의하는 규칙입니다. 주요 목표는 읽을 수 있는 커밋 기록을 만들고 소프트웨어 개발이 프로젝트의 수정 및 업데이트에 대해 더 쉽게 이해할 수 있도록 하는 것입니다.

문서에서 Semantic Versioning 및 Angular 문서와의 강력한 연결을 볼 수 있습니다. 둘 다 명확하고 객관적인 방법론을 얻기 위한 기반입니다. 우리는 로그 생성을 자동화하는 방법, 프로젝트에서 수행되는 변경 사항의 특성에 대한 더 나은 커뮤니케이션 및 생산성 향상과 같은 몇 가지 이점을 얻을 수 있습니다.

Conventional Commit의 구조

<type>[scope optional]: <description>
[ body optional ]
[ footer optional ]

기존 커밋을 사용하는 커밋 구조는 속성 옵션을 소유하는 매우 단순하며 프로젝트에서 사용하기 더 쉬워야 합니다.

헤더

해당 커밋 표준의 구조를 시작하면 반드시 유형과 설명이 있어야 하는 헤더가 있습니다. 범위의 경우 선택 사항이 됩니다.

type 속성에는 몇 가지 유형이 미리 정의되어 있는 Angular Commit Message Guidelines의 문서를 따르는 방법이 있습니다. 설명을 위해 해당 확정 커밋에서 실행된 변경 사항에 대해 몇 줄로 표현해야 합니다.

커밋 유형

build : 컴파일 시스템 또는 외부 종속성에 영향을 미치는 변경에 사용됩니다.
ci : CI 구성 파일 및 스크립트의 변경에 사용됩니다.
docs : 문서에서 변경 사항이 발생할 때만 사용됩니다.
feat : 새 리소스를 추가할 때 사용됩니다.
fix : 버그 수정에 사용됩니다.
perf : 성능을 향상시키는 코드 변경에 사용됩니다.
refactor : 코드 변경이 발생했지만 버그를 수정하지 않고 리소스를 추가하지 않은 경우에 사용됩니다.
style : 코드의 의미에 영향을 미치지 않는 변경에 사용됩니다.
test : 테스트를 추가하거나 기존 테스트를 수정할 때 사용

예를 들어:

fix: remove createUser wrong attribute

범위

범위는 선택적 속성이며 커밋 유형 뒤의 괄호 안에 있는 정보입니다. 당신의 사용은 우리가 상세하거나 불확실한 상황을 작성해야 할 때 더 많이 발생합니다.

주제

헤더의 구조를 완성하려면 설명이 필요하며 소문자로 시작해야 합니다. 또한 명령형을 사용하고 최종 주제에서 점(.)을 사용하지 않아야 합니다.

신체

얼마나 떨어져 있는지는 선택 사항이며 본문은 코드의 변경 사항에 대한 자세한 내용을 설명하는 데 사용할 수 있습니다. 그에게 중요한 또 다른 점은 명령형을 사용하여 작성해야 한다는 사실입니다.

보행인

바닥글은 필수가 아니며 사용이 더 연관되어 있습니다.
이 문제의 커밋이 종료되는 문제의 종료에.

BREAKING CHANGE: 공백 또는 두 줄의 새로운 행이 있는 단어는 바닥글의 이 구조를 작성하기 위해 표시된 형식입니다.

결론

Conventional Commits를 사용할 때 우리는 당신의 구현이 개발 팀과 초보자 개발자에게 많은 개선을 가져올 것이라고 확신할 수 있습니다. 이 규칙을 통해 프로세스가 더 쉬워지고 다른 개발자나 사람들이 우리 프로젝트의 문서를 볼 때 도움이 되는 좋은 커밋 기록을 유지할 수 있습니다.

읽어 주셔서 감사합니다. 힘이 당신과 함께하길 바랍니다!

참조

https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines
https://www.conventionalcommits.org/en/v1.0.0/
https://semver.org/