From dea3ca187a42d52334eb6b02877b5740ff16bf40 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Wed, 22 Jun 2016 16:47:54 -0400 Subject: [PATCH] Added CONTRIBUTING.md --- CONTRIBUTING.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..d5e9bd38e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Contributing to NetBox + +Thank you for your interest in contributing to NetBox! This document contains some quick pointers on reporting bugs and +requesting new features. + +## Reporting Issues + +* First, ensure that you've installed the latest stable version of NetBox. If you're running an older version, it's +possible that the bug has already been fixed. + +* Check the [issues list](https://github.com/digitalocean/netbox/issues) to see if the bug you've found has already been +reported. If you think you may be experiencing a reported issue, please add a quick comment to it with a "+1" and a +quick description of how it's affecting your installation. + +* If you're unsure whether the behavior you're seeing is expected, you can join #netbox on irc.freenode.net and ask +before going through the trouble of submitting an issue report. + +* When submitting an issue, please be as descriptive as possible. Be sure to describe: + + * The environment in which NetBox is running + * The exact steps that can be taken to reproduce the issue (if applicable) + * Any error messages returned + +* Keep in mind that we prioritize bugs based on their severity and how much work is required to resolve them. It may +take some time for someone to address your issue. If it's been longer than a week with no updates, please ping us on +IRC. + +## Feature Requests + +* First, check the [issues list](https://github.com/digitalocean/netbox/issues) to see if the feature you'd like to see +has already been requested (and possibly rejected). If it is, be sure to comment with a "+1" and any additional +justification you have for the feature. + +* While discussion of new features is welcome, it's important to limit the scope of NetBox's feature set to avoid +feature creep. For example, the following features would be firmly out of scope for NetBox: + + * Ticket management + * Network state monitoring + * Acting as a DNS server + * Acting as an authentication server + +* If you're not sure whether the feature you want is a good fit for NetBox, please ask in #netbox on irc.freenode.net. +Even if it's not quite right for NetBox, we may be able to point you to a tool better suited for the job. + +* When submitting a feature request, be sure to include the following: + + * A brief description of the functionality + * A use case for the feature; who would use it and what value it would add to NetBox + * A rough description of any changes necessary to the database schema (if applicable) + * Any third-party libraries or other resources which would be involved