From 6f318e64962a74488dba3951604bb6592f21b220 Mon Sep 17 00:00:00 2001 From: omercier <32134301+omercier@users.noreply.github.com> Date: Mon, 9 Oct 2023 16:18:15 +0200 Subject: [PATCH] Change issue template (#4692) Co-authored-by: cg-tw <83637804+cg-tw@users.noreply.github.com> --- .github/issue_template.md | 64 +++++++++++++++++++++++++++++---------- 1 file changed, 48 insertions(+), 16 deletions(-) diff --git a/.github/issue_template.md b/.github/issue_template.md index 16c79ac7a..f7813bbef 100644 --- a/.github/issue_template.md +++ b/.github/issue_template.md @@ -1,23 +1,55 @@ -Thanks for using centreon-plugins! Please follow the indications shown below according to your issue and describe it in English. +Thank you for using Centreon plugins! + +Please use this form for actual **bugs** only. See **[Other requests](#other-requests)** for more details. +All existing and future issues related to questions, new plugins or enhancements will be closed. + +# Bug report + +If you are certain it is a bug, please ensure that there aren't any [similar issues already open](https://github.com/centreon/centreon-plugins/issues) on the same bug. +If the same bug has already been logged, please close your issue and add a comment pointing to the existing one instead. + +**For the sake of clarity, please remove the explanations from the issue template before submitting your issue.** + +## Quick description + +*In one or two sentences, what it your bug about?* + +## How to reproduce + +*Please provide below the initial conditions to reproduce the bug* + +- **Environment**: result of `uname -a ; cat /etc/redhat-release /etc/debian_version`. +- **Version of the plugin**: version of the package or last commit date if using a clone of this repository. +- **Information about the monitored resource**: the exact model and version of the device, software or product you are trying to monitor. +- **Command line**: the command line that is used. + +## Expected result + +*What you were expecting to have as a result (output, exit return).* + +## Actual result + +*What you actually got. Please put emphasis on what seems wrong to you.* + +# Other requests + +## Questions + +If you have trouble using our plugins, but are not sure whether it's due to a bug or a misuse, please take the time to ask for help on [The Watch, Data Collection section](https://thewatch.centreon.com/data-collection-6) and become certain that it is a bug before submitting it here. ## New Plugins and modes -To develop a Plugin/mode, we need the following: -* SNMP: MIBs files and full snmpwalk of entreprise branch (snmpwalk -ObentU -v 2c -c public address .1.3.6.1.4.1 > equipment.snmpwalk) -* HTTP API (SOAP, Rest/Json, XML-RPC): the documentation and some curls examples -* CLI: command line examples -* SQL: requests -* JMX: mbean names and attributes +There is high demand for new plugins and new functionalities on existing plugins, so we have to rely on our community to help us prioritize them. +How? Post your suggestion on [The Watch Ideas](https://thewatch.centreon.com/ideas) with as much detail as possible and we will pick the most voted topics to add them to our product roadmap. -If some parts of information are confidentials, please send them directly by email to qgarnier@centreon.com. +To develop a plugin/mode, we need the following information, depending on the protocol: +* **SNMP**: MIB files and full snmpwalk of enterprise branch (`snmpwalk -ObentU -v 2c -c public address .1.3.6.1.4.1 > equipment.snmpwalk`) or [SNMP collections](https://thewatch.centreon.com/product-how-to-21/snmp-collection-tutorial-132). +* **HTTP API (SOAP, Rest/Json, XML-RPC)**: the documentation and some curl examples or HTTP [collections](https://thewatch.centreon.com/data-collection-6/centreon-plugins-discover-collection-modes-131). +* **CLI**: command line examples (command + result). +* **SQL**: queries + results + column types or [SQL collections](https://thewatch.centreon.com/product-how-to-21/sql-collection-tutorial-134). +* **JMX**: mbean names and attributes. -Please note that all the developments are open-source. We can't give a date for the development, achievement or release. If it's a priority for you, -send us an email about it (qgarnier@centreon.com) and we'll put you in touch with our company. +If some information is confidential, such as logins or IP addresses, obfuscate them in what is sent publicly and we'll get in touch with you by private message if this information is needed. +Please note that all the developments are open source, we will not commit to a release date. If it is an emergency for you, please contact [Centreon's sales team](https://www.centreon.com/contact/). -## Bug/Question - -If you are reporting a bug/question, make sure that there aren't any similar/duplicates issues already open. You -can ensure this by searching the issue list for this repository. If so, please close your issue and add a comment to the existing one instead. - -Otherwise, open a new issue and provide all parts of information you can (full command line used, actual output, expected output, error message...).