root / README.md @ 5ad9d272
Historique | Voir | Annoter | Télécharger (2,26 ko)
| 1 |
This is the repository for all user contributed stuff |
|---|---|
| 2 |
|
| 3 |
# contrib/plugins/ - 3rd-party plugins |
| 4 |
|
| 5 |
**This is usually where you want to begin your journey.** |
| 6 |
|
| 7 |
Here you'll find all the plugins coming from http://exchange.munin-monitoring.org/. |
| 8 |
That web site is for the time being disabled, new updates are done here. |
| 9 |
|
| 10 |
If a dedicated website comes back alive, its plugin backend will be this git repo. |
| 11 |
|
| 12 |
# contrib/templates/ - 3rd-party templates |
| 13 |
|
| 14 |
Feel free to update templates here, or even to create new ones. |
| 15 |
|
| 16 |
Bonus points for mobile-friendly ones :) |
| 17 |
|
| 18 |
Note that the one named `official` is a loose-synced copy of the one in SVN trunk. |
| 19 |
It should serves as a base for small editions that can be resynced in SVN trunk, so for that : |
| 20 |
|
| 21 |
* don't copy the whole template |
| 22 |
* directly edit files in this directory |
| 23 |
|
| 24 |
# contrib/tools/ - 3rd-party tools |
| 25 |
|
| 26 |
Here, you can put just any kind of tool. Please use this directory instead of a random place on the internet. |
| 27 |
It makes things way more easy to search for others. |
| 28 |
|
| 29 |
And, it serves as an incubator of SVN `trunk/contrib` :-) |
| 30 |
|
| 31 |
# contrib/samples/ - 3rd-party examples of configs |
| 32 |
|
| 33 |
This serves as a repository for examples of various configs. You know, the ''learn by example'' way of doing things. |
| 34 |
|
| 35 |
## Notes to contributors |
| 36 |
|
| 37 |
### Commits, Comments & Pull requests |
| 38 |
|
| 39 |
We like to have ''elementary'' commits as it is much easier to manage for reviewing and debugging. |
| 40 |
So please **don't** be afraid to make **as many** commits as needed. Merging many commits is as easy |
| 41 |
as merging one, if not easier. |
| 42 |
|
| 43 |
A good rationale is that each commit shall have a one-liner commit comment as its first line. |
| 44 |
Next lines are optional and should only explain the ''why'' it is done this particular way. |
| 45 |
|
| 46 |
On the other side, pull requests can regroup many commits at once. |
| 47 |
Just try to explain in the pull comment the ''why'' we should merge it (if it's not obvious). |
| 48 |
|
| 49 |
### Licenses |
| 50 |
|
| 51 |
All the code here is licensed with the same terms as munin itself (GPLv2), unless specified otherwise inside a file. |
| 52 |
In all cases the code shall have an OSI-compatible license. Asking for a pull implies that you agree with that fact. |
| 53 |
|
| 54 |
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 : |
| 55 |
- submit a licensing change pull |
| 56 |
- submit a removal pull |
