Projet

Général

Profil

Paste
Télécharger au format
Statistiques
| Branche: | Révision:

root / README.md @ e59e2d01

Historique | Voir | Annoter | Télécharger (2,88 ko)

1 58f03a96 Steve Schnepp
This is the repository for all user contributed stuff
2 bf387adb Steve Schnepp
3 58f03a96 Steve Schnepp
# contrib/plugins/ - 3rd-party plugins
4 957d0931 Steve Schnepp
5
**This is usually where you want to begin your journey.**
6
7 ba66ff74 Lars Kruse
Here you find a plethora of plugins for the most diverse topics. Please take a look and
8 e59e2d01 Lars Kruse
improve existing or propose new plugins.
9 ba66ff74 Lars Kruse
10 e59e2d01 Lars Kruse
Please read the [hints for plugin contributions](./plugins#contributed-munin-plugins).
11 ba66ff74 Lars Kruse
12 e59e2d01 Lars Kruse
See the [gallery](http://gallery.munin-monitoring.org/) for a browsable overview of these plugins.
13 962d6142 Steve Schnepp
14 957d0931 Steve Schnepp
15 58f03a96 Steve Schnepp
# contrib/templates/ -  3rd-party templates
16 957d0931 Steve Schnepp
17
Feel free to update templates here, or even to create new ones.
18
19
Bonus points for mobile-friendly ones :)
20
21
Note that the one named `official` is a loose-synced copy of the one in SVN trunk. 
22
It should serves as a base for small editions that can be resynced in SVN trunk, so for that : 
23
24
* don't copy the whole template
25
* directly edit files in this directory
26
27 58f03a96 Steve Schnepp
# contrib/tools/ - 3rd-party tools
28 957d0931 Steve Schnepp
29
Here, you can put just any kind of tool. Please use this directory instead of a random place on the internet. 
30
It makes things way more easy to search for others.
31
32
And, it serves as an incubator of SVN `trunk/contrib` :-)
33 355ee21d Steve Schnepp
34 49e7f215 Steve Schnepp
# contrib/samples/ - 3rd-party examples of configs
35
36
This serves as a repository for examples of various configs. You know, the ''learn by example'' way of doing things.
37
38 355ee21d Steve Schnepp
## Notes to contributors
39
40 5ad9d272 Steve Schnepp
### Commits, Comments & Pull requests
41
42 1f5f70ef Steve Schnepp
We like to have _elementary_ commits as it is much easier to manage for reviewing and debugging. 
43 8f26c533 Steve Schnepp
So please **don't** be afraid to make **as many** commits as needed. Merging many commits is as easy
44
as merging one, if not easier.
45
46
A good rationale is that each commit shall have a one-liner commit comment as its first line. 
47 1f5f70ef Steve Schnepp
Ideally that first line has a prefix that shows the part the commit is about. It makes it very
48 a6a1ee1d Steve Schnepp
easy to see grouped changes, and it enable avoiding to look at the `--stat`. To know the prefix you should
49 1f5f70ef Steve Schnepp
use, you can have a look at already existing commits. Next lines are optional and should only
50
explain the _why_ it is done this particular way. 
51 8f26c533 Steve Schnepp
52
On the other side, pull requests can regroup many commits at once.
53
Just try to explain in the pull comment the ''why'' we should merge it (if it's not obvious).
54 355ee21d Steve Schnepp
55 1d2a4303 Steve Schnepp
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.
56
57 5ad9d272 Steve Schnepp
### Licenses
58
59
All the code here is licensed with the same terms as munin itself (GPLv2), unless specified otherwise inside a file.
60
In all cases the code shall have an OSI-compatible license. Asking for a pull implies that you agree with that fact.
61
62
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  :
63
- submit a licensing change pull
64
- submit a removal pull 
65 abdceea1 Stig Sandbeck Mathisen
66
# Building status
67
68
master: [![Build Status](https://travis-ci.org/munin-monitoring/contrib.svg?branch=master)](https://travis-ci.org/munin-monitoring/contrib)