Code

suggest minimum standards for support requests
[nagiosplug.git] / SUPPORT
1 Using the mailing lists and tracker databases at SourceForge are the
2 best ways to obtain direct support for the Nagios Plugins. There may
3 also be commercial support options available to you -- check
4 http://www.nagios.org/ to track the current status of commercial
5 support offerings.
7 There are two mailing lits associated wth Nagios Plugin development:
8 'help' (mailto:nagiosplug-help@lists.sourceforge.net), and 'devel'
9 (mailto:nagiosplug-devel@lists.sourceforge.net). Unless you are fairly
10 certain you have found a bug or thet you are requesting a new feature,
11 please direct support requests to 'help'.
13 Becuase these lists are handled entirely by voluteers, and because
14 these same volunteers are often plugin developers who can also use
15 their time to fix bug and provide feature requests, it is genrally in
16 you interest to do a modest amount of legwork bfore posting to either
17 of these lists.
19 In brief, always provide the version of the software that you are
20 using, and when requsting features or reporting bugs, first check to
21 see that the issue has not already been addressed in the CVS tree.
23 GETTING HELP
25 Requests to 'help' require posting the version number of the
26 plugin. The best place to include the version information is in the
27 subject. A good post would have a subject like:
29   Can I use SSL with check_imap (nagios-plugins 1.3.0-beta2) 1.12
31 If you do not include the verion of the plugin, you risk having your
32 post silently ignored.
34 Be advised that the core plugins (and in fact many of the contributed
35 plugins) will provide a description of their use when invoked with the
36 '--help' option. Please read the help carefully and in it's entirety
37 before asking for support.
39 There is also a support database on the SourceForge-hosted development
40 site. Feel free to use either the mailing list or the web interface,
41 but follow the guideline above for both.
43 REPORTING BUGS AND SUBMITTING PATCHES
45 Bug reports, investigations of possible bugs, feature requests, and
46 patch submissions should be submitted to the development list at
47 (mailto:nagiosplug-devel@lists.sourceforge.net). 
49 As with the support list, you should identify the version, prefrably
50 in the subject line. However, to best use developer resources, it is
51 suggested that you reference your report one of the following sources:
53   1) The most recent release, including beta's
55   2) The twice-daily snapshots (there's a link provided on
56      http://nagiosplug.sourceforge.net)
58   3) The current CVS tree from sourceforge
60 (This does not mean you should run any of these sources in a
61 production environment - the latter two you clearly should
62 not. However, if you find a bug, you should determine whether it is
63 still present in one of these sources, preferably either (2) or (3)
64 which are most recent>)
66 From experince, I know that most bugs can be fixed with only a few
67 more moments work than it takes to determine if the bug is still
68 present in the CVS tree. If you can save a developer the expense of
69 that time, you ensure that bugs are fixed more rapidly, and thus you
70 ensure your problem resolution is reflected in a stable release more
71 quickly.