diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 8c420f0bb2..d20e24ac61 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,17 +1,11 @@ #### Please note -> Please read this information and delete it once ready. +> Please read this information carefully. -- Ensure that your install is upto date before submitting an issue. You can ensure you are upto date by running `./daily.sh` as the librenms user. If you experience errors updating then please run `./validate.php`. +[ ] Is your install up to date? [Updating your install](http://docs.librenms.org/General/Updating/) -- If your issue is a request for us to add a new device then please ensure you provide the following information as pastebin links. +[ ] Please include all of the information between the `====================================` section of `./validate.php`. -Please replace the relevant information in these commands. +[ ] If you would like us to add a new device then please provide the information asked for [here](http://docs.librenms.org/Support/FAQ/#faq20) -```bash -./discovery.php -h HOSTNAME -d -m os -./poller.php -h HOSTNAME -r -f -d -m os -snmpbulkwalk -On -v2c -c COMMUNITY HOSTNAME . -``` - -If possible please also provide what the OS name should be if it doesn't exist already. +[ ] Please provide as much detail as possible. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..5e473ff58e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,7 @@ +#### Please note + +> Please read this information carefully. + +[ ] Have you signed the [Contributors agreement](http://docs.librenms.org/General/Contributing/) + +[ ] Have you followed our [code guidelines?](http://docs.librenms.org/Developing/Code-Guidelines/) diff --git a/doc/Support/FAQ.md b/doc/Support/FAQ.md index c65ca11d2c..92cf165888 100644 --- a/doc/Support/FAQ.md +++ b/doc/Support/FAQ.md @@ -20,6 +20,7 @@ ### Developing - [How do I add support for a new OS?](#faq8) + - [What information do you need to add a new OS?](#faq20) - [What can I do to help?](#faq9) - [How can I test another users branch?](#faq13) @@ -153,6 +154,20 @@ This file will usually set the variables for $version and $hardware gained from **html/images/os/$os.png** This is a 32x32 png format image of the OS you are adding support for. +#### What information do you need to add a new OS? + +Please provide the following output as seperate non-expiring pastebin.com links. + +Replace the relevant information in these commands such as HOSTNAME and COMMUNITY. + +```bash +./discovery.php -h HOSTNAME -d -m os +./poller.php -h HOSTNAME -r -f -d -m os +snmpbulkwalk -On -v2c -c COMMUNITY HOSTNAME . +``` + +If possible please also provide what the OS name should be if it doesn't exist already. + #### What can I do to help? Thanks for asking, sometimes it's not quite so obvious and everyone can contribute something different. So here are some ways you can help LibreNMS improve.