좋은 커밋 메시지를 작성하는 방법?

커밋 메시지란?


commit 명령은 Git에서 스테이징한 후 로컬 리포지토리에 변경 사항을 저장하는 데 사용됩니다. 로컬 리포지토리에 저장하기 전에 많은 변경 사항을 수행했으므로 Git에 어떤 변경 사항을 저장해야 하는지 알려야 합니다. 이를 수행하는 더 좋은 방법은 커밋 메시지를 추가하여 수행한 변경 사항을 알려주는 것입니다.

좋은 커밋 메시지를 작성해야 하는 이유는 무엇입니까?



프로젝트 이력이 나만 볼 수 있다면 무엇이든 쓰시면 됩니다. 그러나 그 프로젝트에 여러 사람이 참여하는 경우 좋은 커밋 메시지를 작성해야 합니다. 그들이 더 잘 이해할 수 있도록. 대략적으로 말하면 커밋은 각 변경 사항, 변경 내용 및 이유에 대한 설명입니다.

커밋 메시지는 그러한 변경이 이루어진 이유를 자주 전달하므로 더 잘 이해하는 데 도움이 됩니다. 따라서 더 나은 이해와 협업은 작업을 더 효율적으로 만듭니다.

세 가지 중요한 사항이 있습니다.
  • 검토 프로세스의 속도를 높이려면
  • 개발자 팀이 좋은 릴리스 정보를 작성하는 데 도움이 됩니다.
  • 미래의 메인테이너를 돕기 위해(이런 기능이 추가된 이유).

  • 좋은 커밋 메시지를 작성하는 방법?



    좋은 커밋 메시지에 대한 엄격한 정의는 없지만 일반적인 규칙이 등장했습니다. 커밋 메시지에는 논리적 변경이 하나만 있어야 합니다.

    다른 개발자 팀과 회사에서 사용하는 몇 가지 규칙이 있습니다. 특정 회사에서 일한다면 그들의 관습을 따라야 합니다.

    좋은 커밋 메시지는 당신이 협력하고 있는 다른 사람들에게 뿐만 아니라 당신에게도 좋습니다. 당신의 역사를 되돌아보면 훨씬 더 잘 이해할 수 있습니다.

    일반적인 형식은 다음과 같습니다.

    Short (72 chars or less) summary of changes

    More details explanatory text. wrap it to 72 characters. The blank
    line separating the summary from the body is critical(unless you
    omit the body entirely).

    Write you commit message in the imperative: "Fix bug " and not "Fixed bug" or "Fixes bug".This convention matches up with commit messages generated by commands like git merge and git revert.
    Further paragraphs come after blank lines.

    • Bullet points are okay, too.
    • Typically a hyphen or asterisk is used for the bullet, followed >by a single space. Use a hanging indent.


    훌륭한 git commit 메시지 스타일을 위한 규칙


  • 제목과 본문을 공백으로 구분
  • 제목 줄을 마침표로 끝내지 마십시오
  • .
  • 제목과 각 단락을 대문자로 표기
  • 제목에 명령형 분위기를 사용하라
  • 72자로 줄 바꿈
  • 몸을 사용하여 무엇을 왜 했는지 설명하십시오. ~ 안에
    대부분의 경우 변경 사항에 대한 세부 정보를 생략할 수 있습니다.
    만들어졌다.

  • 당신도 좋은 것을 만들 수 있습니다. 이것은 내가 사용한 형식입니다.

       type : subject
    
       body (optional) 
    


    1.유형


  • feat: 특정 애플리케이션에 추가하는 새로운 기능
  • 수정: 버그 수정
  • 스타일: 스타일링과 관련된 기능 및 업데이트
  • 리팩토링: 코드베이스의 특정 섹션을 리팩토링
  • 테스트: 테스트와 관련된 모든 것
  • 문서: 문서와 관련된 모든 것
  • chore: 정기적인 코드 유지 관리.[ 이모티콘을 사용하여
    커밋 유형을 나타냄]

  • 2.주제



    변경 사항에 대한 간략한 설명입니다. 대문자로 시작해야 하며 50자를 넘지 않아야 합니다. 예: 추가된 x 필터 대신 x 필터를 추가하거나 x 필터를 추가합니다.

    3.바디



    변경한 내용과 변경한 이유를 설명하는 데 사용됩니다. 모든 커밋 메시지에 본문이 필요한 것은 아니며 선택 사항입니다.

    팁: 여러 논리가 있고 커밋하기 어렵다면 메시지를 분할하여 수행합니다.

    하지 않는 방법:


  • 하루 일과 커밋을 하지 마십시오. 히스토리를 살펴보면 지저분해 보이고 다른 사람들은 이해할 수 없습니다.
  • 게으른 커밋을 하지 마세요. 다른 사람들이 프로젝트의 진행 상황을 이해하기가 정말 어렵습니다.

  • git에 대해 더 알고 싶다면:


  • https://try.github.io/
  • https://git-scm.com/book/en/v2
  • 좋은 웹페이지 즐겨찾기