Skip to content
Snippets Groups Projects
Unverified Commit f3d1fa15 authored by Mantas Mikulėnas's avatar Mantas Mikulėnas
Browse files

docs: Recommend the usual commit message rules

It is much easier to review commits (e.g. with `tig`) if they have a
short subject line – e.g. a sysadmin might want to quickly skip all the
"docs: Foo" and "tests: Bar" commits and focus on the important parts.
parent 63e3c7ce
No related branches found
No related tags found
No related merge requests found
...@@ -55,6 +55,12 @@ attention to: ...@@ -55,6 +55,12 @@ attention to:
* Do not include many changes in every commit. Commits should be focused and address one single problem or feature. By * Do not include many changes in every commit. Commits should be focused and address one single problem or feature. By
having **multiple, small commits** instead of few large ones, it is easier to track what you are doing, revert changes having **multiple, small commits** instead of few large ones, it is easier to track what you are doing, revert changes
in case of an error and help you out if needed. in case of an error and help you out if needed.
* Try to write clean **commit messages**, largely based on the [seven rules](http://chris.beams.io/posts/git-commit/):
* Write a **short** subject line, followed by a blank line and a longer explanation.
* Prefix the subject line with the component(s) changed, e.g. "docs: Update foo", or "SAML: Don't log bar twice",
or "tests: Add tests for quux".
* Explain **what and why** in the commit message, not just _how_. Things obvious now might become quite confusing
when rediscovered years later.
* **Be explicit**. Add comments. Use strict comparison operators like `===` and check for specific values when testing * **Be explicit**. Add comments. Use strict comparison operators like `===` and check for specific values when testing
conditions. conditions.
* **Keep things simple**. Avoid big functions, long nested loops or `if` statements. * **Keep things simple**. Avoid big functions, long nested loops or `if` statements.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment