Mirrors/Munin-Contrib
1
0
Fork 0
mirror of https://github.com/munin-monitoring/contrib.git synced 2025-07-21 18:41:03 +00:00
Code Issues Releases Wiki Activity

Expanded the commit comments rationale

Browse source
This commit is contained in:
Steve Schnepp 2012-05-21 12:44:45 +03:00
parent 0df18b5314
commit 8f26c533bc
1 changed files with 9 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -34,6 +34,13 @@ This serves as a repository for examples of various configs. You know, the ''lea
## Notes to contributors
We like to have ''elementary'' commits (a good rationale is : one per Changelog entry), as it is much easier to manage for reviewing. Debugging is also usually easier that way.
We like to have ''elementary'' commits as it is much easier to manage for reviewing and debugging.
So please **don't** be afraid to make **as many** commits as needed. Merging many commits is as easy
as merging one, if not easier.
A good rationale is that each commit shall have a one-liner commit comment as its first line.
Next lines are optional and should only explain the ''why'' it is done this particular way.
On the other side, pull requests can regroup many commits at once.
Just try to explain in the pull comment the ''why'' we should merge it (if it's not obvious).
So please **don't** be afraid to make as many commits as needed.