README: whitespace adjustments
This commit is contained in:
parent
bd872f7af1
commit
047725bc2a
16
README.md
16
README.md
|
@ -24,9 +24,10 @@ It should serves as a base for small editions that can be resynced in SVN trunk,
|
|||
* don't copy the whole template
|
||||
* directly edit files in this directory
|
||||
|
||||
|
||||
# contrib/tools/ - 3rd-party tools
|
||||
|
||||
Here, you can put just any kind of tool. Please use this directory instead of a random place on the internet.
|
||||
Here, you can put just any kind of tool. Please use this directory instead of a random place on the internet.
|
||||
It makes things way more easy to search for others.
|
||||
|
||||
And, it serves as an incubator of SVN `trunk/contrib` :-)
|
||||
|
@ -35,33 +36,36 @@ And, it serves as an incubator of SVN `trunk/contrib` :-)
|
|||
|
||||
This serves as a repository for examples of various configs. You know, the ''learn by example'' way of doing things.
|
||||
|
||||
|
||||
## Notes to contributors
|
||||
|
||||
### Commits, Comments & Pull requests
|
||||
|
||||
We like to have _elementary_ commits as it is much easier to manage for reviewing and debugging.
|
||||
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.
|
||||
A good rationale is that each commit shall have a one-liner commit comment as its first line.
|
||||
Ideally that first line has a prefix that shows the part the commit is about. It makes it very
|
||||
easy to see grouped changes, and it enable avoiding to look at the `--stat`. To know the prefix you should
|
||||
use, you can have a look at already existing commits. Next lines are optional and should only
|
||||
explain the _why_ it is done this particular way.
|
||||
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).
|
||||
|
||||
Tim Pope wrote a [very nice tuto](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) on making good commit comments.
|
||||
|
||||
|
||||
### Licenses
|
||||
|
||||
All the code here is licensed with the same terms as munin itself (GPLv2), unless specified otherwise inside a file.
|
||||
In all cases the code shall have an OSI-compatible license. Asking for a pull implies that you agree with that fact.
|
||||
|
||||
This change was made on Jun 1st 2012. If you wrote some code earlier and you do not agree to the new licensing default, you can :
|
||||
This change was made on Jun 1st 2012. If you wrote some code earlier and you do not agree to the new licensing default, you can:
|
||||
- submit a licensing change pull
|
||||
- submit a removal pull
|
||||
- submit a removal pull
|
||||
|
||||
|
||||
# Building status
|
||||
|
||||
|
|
Loading…
Reference in New Issue