SUPPORT

   1 SUPPORT
   2
   3 Using the mailing lists and issue tracker at GitHub are the
   4 best ways to obtain direct support for the Monitoring Plugins. There may
   5 also be commercial support options available to you -- check
   6 http://www.nagios.org/ to track the current status of commercial
   7 support offerings.
   8
   9 There are two mailing lists associated with Monitoring Plugins development:
  10 'help' (mailto:help@monitoring-plugins.org), and 'devel'
  11 (mailto:help@monitoring-plugins.org). Unless you are fairly
  12 certain you have found a bug or that you are requesting a new feature,
  13 please direct support requests to 'help'.
  14
  15 Because these lists are handled entirely by volunteers, and because
  16 these same volunteers are often plugin developers who can also use
  17 their time to fix bug and provide feature requests, it is generally in
  18 you interest to do a modest amount of legwork before posting to either
  19 of these lists.
  20
  21 Plugins that are in the contrib directories are provided as-is. We will
  22 try to help, but sometimes the plugins have dependencies that the monitoring-plugin
  23 developers do not have access to. You may be able to try the authors
  24 directly.
  25
  26 In brief, always provide the version of the software that you are
  27 using, and when requesting features or reporting bugs, first check to
  28 see that the issue has not already been addressed in the current Git
  29 code.
  30
  31 GETTING HELP
  32
  33 Requests to 'help' require posting the version number of the
  34 plugin. The best place to include the version information is in the
  35 subject. A good post would have a subject like:
  36
  37   Can I use SSL with check_imap (monitoring-plugins 1.3.0-beta2) 1.12
  38
  39 If you do not include the version of the plugin, you risk having your
  40 post silently ignored.
  41
  42 Be advised that the core plugins (and in fact many of the contributed
  43 plugins) will provide a description of their use when invoked with the
  44 '--help' option. Please read the help carefully and in it's entirety
  45 before asking for support.
  46
  47 REPORTING BUGS AND SUBMITTING PATCHES
  48
  49 Bug reports, investigations of possible bugs, feature requests, and
  50 patch submissions should be submitted to the development list at
  51 mailto:devel@monitoring-plugins.org. Please raise an issue first
  52 in GitHub, otherwise your email is likely to be missed over time.
  53
  54 You should identify the version, preferably in the subject line.
  55 However, to best use developer resources, it is suggested that you
  56 reference your report to one of the following sources:
  57
  58   1) The most recent release, including beta's
  59
  60   2) The current snapshots (there's a link provided on
  61      https://www.monitoring-plugins.org/download.html)
  62
  63   3) The current Git code from GitHub
  64
  65 (This does not mean you should run any of these sources in a
  66 production environment - the latter two you clearly should
  67 not. However, if you find a bug, you should determine whether it is
  68 still present in one of these sources, preferably either (2) or (3)
  69 which are most recent.)
  70
  71 From experience, I know that most bugs can be fixed with only a few
  72 more moments work than it takes to determine if the bug is still
  73 present in the Git tree. If you can save a developer the expense of
  74 that time, you ensure that bugs are fixed more rapidly, and thus you
  75 ensure your problem resolution is reflected in a stable release more
  76 quickly.