summaryrefslogtreecommitdiffstats
path: root/web/input/development.md
blob: ddff634f49ced00e10f2946ce6f8f686f6f849cb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
title: Development
parent: Home
menu-position: 5
---

# Development

## Software Repositories

The [Nagios Plugins Development Team][team] takes care of three projects:

* Nagios Plugins — the core bundle of standard plugins.
* Nagios::Plugin — a module used by plugins written in Perl.
* NagiosMIB — SNMP MIB files for traps sent from [Nagios][nagios].

These projects are maintained in separate repositories on [GitHub][github]:

* <https://github.com/nagios-plugins/repositories>

Contributions are always welcome!  If you'd like to provide patches, please
[fork][fork] the desired repository and submit a [pull request][pull].  In
case you're not familiar with Git, you might want to look into [Scott
Chacon][scott]'s [Pro Git][book] book available on the [Git web site][git]
first.

## Development Guidelines

Apart from the actual code, the [team][team] also maintains the official
[Nagios Plugin Development Guidelines][guidelines].  If you plan on
contributing to the standard plugins package, or writing your own checks, you
should read them!

## Test Suite

The Nagios Plugins bundle comes with an extensive test suite.  Some of the
tests require [libtap][libtap], a copy of which is shipped with the Nagios
Plugins source tarball.  In order to execute all tests, issue the following
commands:

    $ ./tools/setup # When building from Git.
    $ ./configure --enable-libtap
    $ make
    $ make test

Regular tests of the latest code are scheduled automatically on various
platforms, the results can be [viewed online][tests].

[team]: team.html "Nagios Plugins Development Team"
[nagios]: http://www.nagios.org/ "Nagios"
[github]: https://github.com/ "GitHub"
[fork]: https://help.github.com/articles/fork-a-repo "Fork Documentation"
[pull]: https://help.github.com/articles/using-pull-requests "Pull Request Documentation"
[scott]: http://scottchacon.com/ "Scott Chacon"
[book]: http://git-scm.com/book "Pro Git"
[git]: http://git-scm.com/ "Git"
[guidelines]: doc/guidelines.html "Nagios Plugin Development Guidelines"
[libtap]: http://jc.ngo.org.uk/trac-bin/trac.cgi/wiki/LibTap "LibTap Homepage"
[tests]: tests.html "Test Results"

<!--% # vim:set filetype=markdown textwidth=78 joinspaces: # %-->