root / README.md @ 6ee4fc8d
Historique | Voir | Annoter | Télécharger (2,8 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 | Here you'll find all the plugins coming from http://exchange.munin-monitoring.org/. |
||
| 8 | 962d6142 | Steve Schnepp | 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 | 957d0931 | Steve Schnepp | |
| 12 | 58f03a96 | Steve Schnepp | # contrib/templates/ - 3rd-party templates |
| 13 | 957d0931 | Steve Schnepp | |
| 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 | 58f03a96 | Steve Schnepp | # contrib/tools/ - 3rd-party tools |
| 25 | 957d0931 | Steve Schnepp | |
| 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 | 355ee21d | Steve Schnepp | |
| 31 | 49e7f215 | Steve Schnepp | # 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 | 355ee21d | Steve Schnepp | ## Notes to contributors |
| 36 | |||
| 37 | 5ad9d272 | Steve Schnepp | ### Commits, Comments & Pull requests |
| 38 | |||
| 39 | 1f5f70ef | Steve Schnepp | We like to have _elementary_ commits as it is much easier to manage for reviewing and debugging. |
| 40 | 8f26c533 | Steve Schnepp | 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 | 1f5f70ef | Steve Schnepp | Ideally that first line has a prefix that shows the part the commit is about. It makes it very |
| 45 | a6a1ee1d | Steve Schnepp | easy to see grouped changes, and it enable avoiding to look at the `--stat`. To know the prefix you should |
| 46 | 1f5f70ef | Steve Schnepp | use, you can have a look at already existing commits. Next lines are optional and should only |
| 47 | explain the _why_ it is done this particular way. |
||
| 48 | 8f26c533 | Steve Schnepp | |
| 49 | On the other side, pull requests can regroup many commits at once. |
||
| 50 | Just try to explain in the pull comment the ''why'' we should merge it (if it's not obvious). |
||
| 51 | 355ee21d | Steve Schnepp | |
| 52 | 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. |
| 53 | |||
| 54 | 5ad9d272 | Steve Schnepp | ### Licenses |
| 55 | |||
| 56 | All the code here is licensed with the same terms as munin itself (GPLv2), unless specified otherwise inside a file. |
||
| 57 | In all cases the code shall have an OSI-compatible license. Asking for a pull implies that you agree with that fact. |
||
| 58 | |||
| 59 | 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 : |
||
| 60 | - submit a licensing change pull |
||
| 61 | - submit a removal pull |
||
| 62 | abdceea1 | Stig Sandbeck Mathisen | |
| 63 | # Building status |
||
| 64 | |||
| 65 | master: [](https://travis-ci.org/munin-monitoring/contrib) |
