TIL - 커밋 메시지 규칙

장숭혁·2023년 10월 25일
0

TIL작성

목록 보기
4/60

커밋 메시지 7규칙

  1. 제목과 본문을 빈 행으로 구분
  2. 제목 50글자 이내 제한
  3. 제목의 첫글자는 대문자
  4. 제목 끝에는 마침표를 넣지 않음
  5. 제목은 명령문 사용 과거형 X
  6. 본문 각 행 길이 72자 내
  7. 어떻게 보다는 무엇과 왜를 설명

- commit-message-convention.md

  1. Separate subject from body with a blank line.
  2. Limit the subject line to 50 characters.
  3. Capitalize the subject line.
  4. Do not end the subject line with a period.
  5. Use the imperative mood in the subject line.

    -예시 : Write the subject line in the imperative mood, which gives a sense of command or action. For example, use "Add feature" instead of "Added feature."

  6. Wrap the body at 72 characters.
  7. Use the body to explain what and why vs. how.

    -예시: In the body of the commit message, provide a clear explanation of what changes were made and why they were made. Avoid going into the specifics of how the changes were implemented; that information is often better suited for code comments or documentation.

 커밋 메시지 구조
 Type : Subject
 
	body
    
	footer
        

Type (유형):
커밋의 종류 또는 유형을 나타냅니다. 주로 다음 중 하나로 지정됩니다:

  • feat: 새로운 기능 추가
  • fix: 버그 수정
  • refactor: 코드 리팩터링 (구조 변경, 리팩터링)
  • docs: 문서 관련 변경
  • chore: 빌드, 테스트, 패키지 관리 등과 같은 루틴 작업
  • ci: ci 관련 설정 수정에 대한 커밋
  • docs: 문서 수정에 대한 커밋
  • style: 코드 스타일 혹은 포맷등에 관한 커밋
  • refactor 코드 리팩토링에 대한 커밋
  • test: 테스트 코드 수정에 대한 커밋
  • perf: 성능 개선에 대한 커밋

Subject (제목):
커밋의 간단한 요약 또는 제목을 나타냅니다.
50자 내외로 짧게 유지하고, 첫 글자는 대문자로 시작하며 마침표를 사용하지 않습니다.
일반적으로 제목은 명령문 형태로 작성하며, 이로써 어떤 작업이 수행되었는지를 명확하게 표현합니다.

Body (본문):
제목 이후에 한 줄을 비우고, 변경 내용과 왜 이러한 변경이 이루어졌는지에 대한 상세한 설명을 기술합니다.
설명을 위해 본문을 사용하며, 변경 내용의 세부사항을 설명합니다. "왜"에 대한 설명도 포함합니다.
행은 72자 이내로 유지하려고 노력합니다.

Footer (푸터):
커밋과 관련된 다양한 메타 정보를 추가할 수 있는 영역입니다. 일반적으로 이슈 추적, 이슈 닫힘, 릴리즈 노트 생성 등의 정보를 추가합니다.

예시: "Closes #123" (이슈 번호 123을 닫는다는 의미) 또는 "Breaking Change"와 같은 추가 정보를 제공할 수 있습니다.

feat: Add user authentication
~

  • Implement user authentication using OAuth2.
  • Integrate social login providers (Google, Facebook).
  • Store user information securely.
    ~
    Closes #789
profile
코딩 기록

0개의 댓글

관련 채용 정보