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