👿

Git Commit Message

Guidelines

•

Seperate subject from body with a blank line

•

Do not end the subject liine with a period

•

Capitalize the subject line and each paragraph

•

Use the imperative mood in the subject line

•

Wrap lines at 72 characters

•

Use the body to explain what and why you have done something rather than how. 

Summary

<subject line> : capitalized imperative short summary

<body> : focused on what and why

<footer> : if you have specific issue number or ticket
Plain Text
복사

Tips

Use type on subject line if you want:

•

feat - a new feature

•

fix - a bug fix

•

docs - changes in documentation

•

style - everything related to styling

•

refactor - code changes that neither fixes a bug or adds a feature

•

test - everything related to testing

•

chore - updating build tasks, package manager configs, etc

Use bullet points on body paragraph - I prefer this

Put references on footer if you use an issue tracker:

Resolves: #123
See also: #456, #789
Plain Text
복사

References

[Git] 좋은 커밋 메세지 작성하기위한 규칙들

코드를 작성하면서 어려운것들중 하나는 이름을 어떻게 짓는지에 대한 고민 바로`Naming` 일 것입니다.클래스, 함수, 변수 등등 많은 이름을 고민하지만 그 중 하나인 커밋 메시지를 어떻게 작성하여야 좋은 커밋 메시지일지에 대하여 알아보도록 하겠습니다. 1. 제목과 본문을 빈 행으로 구분한다 2. 제목을 50글자 내로 제한 3. 제목 첫 글자는 대문자로 작성 4.

https://beomseok95.tistory.com/328

Commit message guidelines

Short (72 chars or less) summary More detailed 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 your commit message in the imperative: "Fix bug" and not "Fixed bug" or "Fixes bug."

https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53

How To Write Proper Git Commit Messages

A git commit records changes to a repository. A git commit is executed in the course of a project to record progress. This progress is then pushed to a remote repository (like on github.com) by executing a git push. These changes or progress could mean any additions, deletions, or updates to the files stored in the repository.

https://medium.com/@steveamaza/how-to-write-a-proper-git-commit-message-e028865e5791