A Truly Proper Commit

A truly proper commit is written with a keyword denoting what type of change has been made to a file. Words like:

bug/…
feat/…
test/…
doc/…
refactor/…

A truly proper commit is written in the present tense. A reminder for this to preface all commits with “this commit will” this is so that the writer can easily get in the mind state of writing the message in present tense. This should only be added in the mind of the writer not actually written into the commit message.

A truly proper commit contains at max seventy characters. If the commit exceeds this widely recognized limit then the original commit will be followed by an empty line which will then contain the the extra details of the commit message.

A truly proper commit’s messages are as important an aspect of programming as good variable names, documentation and clean code. A truly proper commit message can give all the information necessary for a programmer looking over your commit history, or more likely, it can give the programmer who wrote the code initially a solid idea of where they will be in their program by reverting to a previous commit.

True Example: (refactor) — the mysql database to use sequelize

One clap, two clap, three clap, forty?

By clapping more or less, you can signal to us which stories really stand out.