Github 3 commit tip

20 Feb 2022

---

Git commit tip

- Title / Body separate

commit내용을 제목을 띄우고 작성하면

        git commit -m"Fix: typo some docs some sentence"

        git commit -m"Fix: typo
                    some docs some sentencs"

git log 명령어를 사용했을 경우 큰 차이 없이 보여지지만

        $ git log
        commit 42e769bdf4894310333942ffc5a15151222a87be
        Author: Kevin Flynn <kevin@flynnsarcade.com>
        Date: Fri Jan 01 00:00:00 1982 -0200

        Fix: typo

        some docs some sentencs

git log –online / git shortlog 명령어를 사용했을 때

        $ git log --oneline
        42e769 Fix: typo

위처럼 그동안 commit해온 내용들의 제목만 잘라서 보여줌

- Title : 영자 50 / 대문자 / . 금지 / 명령조

• 영자기준 50자 (출력시 한줄안쪽)
  
• 첫글자는 대문자
  
• . 사용금지
  
• 명령조 : 시각적으로 간결하고 시스템 명령문과도 일치

- Body : 영자 72자

• 영자 기준 72자 마다 줄을 바꾸면 출력시 시각적으로 잘 정돈됨
• 어떻게 보다 무엇을, 왜 에 맞춰 작성하기

References

Writing good commit messages
How to Write a Git Commit Message
5.2 Distributed Git - Contributing to a Project
PRETTY FORMATS