본문으로 건너뛰기

Git commit message

Message​

<type>[(<scope>)]: <subject>

[<body>]

[<footer>]
  • <type>
    • fix: 버그 수정 (SemVer, PATCH)
    • feat: 새로운 기능 (SemVer, MINOR)
    • <type>!: !는 BREAKING CHANGE를 의미합니다. (SemVer, MAJOR)
    • perf: 성능 개선
    • test: 테스트 코드 추가, 수정
    • refactor: feat, fix가 아닌 코드 수정
    • docs: 문서만 수정
    • chore: 다른 타입에 해당하지 않는 변경사항
  • <scope>: 변경된 코드 범위를 나타내는 모든 것으로 생략이 가능합니다.
  • <subject>
    • 명령형을 사용합니다.
    • 소문자로 시작합니다.
    • .(구두점)으로 끝나지 않습니다.
  • <body>
  • <footer>
    • git tailer format
    • <token>: <value> 형식으로 작성합니다.
    • <token>에 공백이 들어간 경우 공백 대신 -를 사용합니다.
      • BREAKING CHANGE: <description>는 예외입니다.
정보

헤더는 50자, 본문은 72자 줄 길이(line length)를 권장하는 글이 많습니다.

<subject> example​


  • 필요한 경우 아니면 관사 사용을 하지 않습니다
  • 명령형을 사용합니다
  • add A for B
    • add printk for debug
    • add support for xxx
  • add A to B
    • add is_open to tty0uart_uart_serial
  • allow A to B
  • avoid A
  • avoid A if B
  • avoid A when B
  • correct A(문법 오류, 타입 변경, 이름 변경)
    • correct variable name and type
  • ensure A
  • fix typo
  • fix A
    • fix typo
    • fix incorrect run command
  • fix A in B
    • fix error condition in Uart::begin
  • fix A which B
  • fix A that B
    • fix crash that occurs when removing and reinserting
  • fix A to B
  • fix A so that B
  • fix A where B
    • fix issue where log does not match log level
  • fix A when B
  • implement A(Add 보다 좀더 큰 단위 코드 추가)
    • implement basic frame for uart_ops
  • implement A to B
  • improve A
  • make A B
  • move A (in)to B
    • move *_linux.cpp into linux directory
  • pass A to B
  • prevent A
    • prevent reopen when already open
  • prevent A from B
    • prevent write() from printing KERN_ERR
  • prevent A if B
    • prevent installation if libgpiodcxx v1.0 or lower
  • refactor A (뒤엎은 경우)
    • refactor tty0uart_tty functions
  • remove A
  • remove A from B
  • rename A to B
  • revise A
    • revise log level
  • set A to B
  • simplify A
  • use A for B
  • use A to B
    • use throw to handle errors instead of exit()
  • use A in B
  • use A instead of B
  • update A to B
  • verify A

Close issue(GitHub)​

제목이나 내용에 close #1004라는 문구가 있으면 1004번 이슈에 해당 커밋에 의해 종료되었다는 글이 추가되고 이슈는 닫힙니다.

  • close
  • closes
  • closed
  • fix
  • fixes
  • fixed
  • resolve
  • resolves
  • resolved