A Proper Commit

A proper commit is written with a prefix denoting what type of change has been made to a file. These prefixes can be things like “bug”, “feat” (for feature), “fix”, “refactor”, “test”, and “doc”. Each would be put in a parenthesis.

A proper commit strives for seventy characters max. If further elaboration is needed an the initial commit message is followed by an empty line before any further text.

A proper commit is written in the present tense. A reminder for this is to preface all commits with “This commit will”. This should only be added in the mind of the programmer and should not appear in the actual commit message.

Proper commit messages are as important an aspect of programming as good variable names and clean code. A 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.

Example: (feat) connect server to database

One clap, two clap, three clap, forty?

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