practicalli / spacemacs

Content for the book - Clojure Development with Spacemacs
https://practical.li/spacemacs
Creative Commons Attribution Share Alike 4.0 International
109 stars 33 forks source link

Writing clear commit messages #276

Open practicalli-johnny opened 3 years ago

practicalli-johnny commented 3 years ago

title should contain the component it mostly affects, followed by a summary of the overall change

Then an empty line

The body describing the change in detail, starting with the purpose or rational behind the change.

Use markup or other notation that is supported by the code repository web interface, to make pull requests even clearer.

Resolve: #9751245 at the end of the commit message to specify a specific issue that should be closed.
Related: #54554321 at the end of a commit message to link to related issues or pull requests.

Other suggestions