산업 표준 Git 커밋 메시지 작성 가이드

이 기사를 시작하기 전에 이미 Git에 대해 들어본 적이 있을 것입니다. 여러분을 여기로 이끈 것이 무엇이든 환영합니다. 해결책을 찾으시기 바랍니다.

Git에 대한 간략한 설명

기여가 필요한 대규모 프로젝트가 있습니다. Git은 개발자가 다양한 기여를 관리하고 이를 하나의 단위로 묶는 데 도움을 주기만 합니다. 그것은 또한 버전 제어인 프로젝트의 버전을 제어하는 ​​데 도움이 됩니다. 이것은 더미 정의이지만 Git을 설명할 수 있는 가장 좋은 방법입니다.

Git의 표준적인 의미는 소스 코드를 관리하는 데 사용되는 DevOps 도구입니다. 소규모에서 초대형 프로젝트를 효율적으로 처리하는 데 사용되는 무료 오픈 소스 버전 제어 시스템입니다.

계속하기 전에 약간의 git 작업 흐름을 이해하는 것이 좋습니다Here.

힘내 커밋

Git 커밋은 코드베이스 또는 프로젝트의 현재 단계/상태에 대한 스냅샷입니다. 이를 통해 시스템은 단계적 변경 사항을 저장할 수 있습니다.
커밋은 프로젝트의 기여 및 변경에 대한 타임라인으로 사용되며 프로젝트의 이정표를 정의하는 데에도 도움이 됩니다. 커밋은 팀의 생산성과 KPI를 추적하는 데에도 사용할 수 있습니다.

업계 표준 Git 커밋

저는 이것을 기술 생태계 전반에서 일반적으로 이해할 수 있는 Git 커밋으로 설명하기로 선택했습니다. 매우 복잡한 용어를 포함하는 메시지를 커밋해서는 안 되며, 코드 기반에 기여하지 않는 사람들도 읽고 이해할 수 있어야 합니다.

업계 표준 커밋의 필요성

이제 이것의 필요성은 커밋 메시지를 통해 커밋 메시지를 통해 변경 사항을 이해할 수 있어야 하는 코드를 다시 살펴보더라도 커밋 메시지를 커밋 코드에 맞게 만드는 것입니다. 또한 새로운 기여자가 커밋 및 변경 사항을 이해하는 데 도움이 됩니다. 사람이 이 커밋을 한 이유와 특정 코드 줄을 변경하면 어떤 영향을 미칠지 알 수 있습니다.

커밋 메시지는 다음과 같아야 합니다.

이해할 수 있는

충분하다

명확한

커밋 메시지를 만들기 전에 다음 사항을 고려해야 합니다.

이 커밋을 추가한 이유

이 커밋으로 인해 변경되는 사항

변경이 필요합니까

변경 사항이 티켓을 해결합니까, 아니면 외부 링크 또는 코드의 일부를 참조합니까

우리가 확인할 업계 표준 커밋 메시지 방법은

<type>[optional scope]: <description>

[optional body]

[optional footer]

살펴볼 수 있는 다양한 표준 커밋 유형:

수정: 이것은 코드베이스에서 해결된 버그를 커밋하는 것입니다.

feat: 이것은 코드 베이스에 새로운 기능을 커밋하는 것입니다.

chore: 종속성 수정 또는 업데이트와 관련된 기능 또는 버그와 관련되지 않은 변경 사항을 커밋합니다.

리팩터링 - 리팩터링된 코드 또는 변경 사항을 포함하는 리팩터링된 코드와 관련된 변경 사항을 커밋합니다.

docs - 문서, readme.md 또는 마크다운 파일의 변경 사항을 커밋합니다.

style - 이것은 코드베이스의 스타일 변경을 포함합니다.

테스트 - 수정 사항을 포함하여 테스트 파일의 변경 사항을 커밋합니다.

perf - 앱의 성능을 개선하기 위해 커밋합니다.

ci - 이 커밋은 파일 및 스크립트와 같은 CI 통합을 변경합니다.

빌드 - 빌드 파일 및 파란색 종속성과 관련된 파일입니다.

되돌리기 - 이 커밋은 이전 커밋으로 되돌리는 것을 의미합니다.

이에 대한 예는 다음과 같습니다.

위업: 홈페이지에 출금 버튼 추가

이모티콘과 함께 표준 커밋을 추가할 수도 있습니다. 다양한 커밋 유형에는 다음과 같은 다양한 이모티콘이 있습니다.
수정: 연락처 양식 수정
이에 대해 자세히 알아보기here

결론:

이 글에서 배운 기술은 당신을 향상시키고 코드베이스를 더 체계적으로 만들 것입니다. 프로세스를 문서화하고 변경 사항을 추적해야 합니다.

코드가 레거시 코드가 되어 새 개발자가 작업해야 하는 경우 커밋 메시지를 통해 들어오는 개발자가 부재 중에도 코드베이스에서 훨씬 쉽게 작업할 수 있습니다.

커밋을 개선하는 방법에 대한 제안이 있으면 아래에 제안할 수 있습니다.

git 커밋 메시지 개선에 대한 이 기사에서 우리 모두가 무언가를 배웠기를 바랍니다.