|
@@ -1,8 +1,8 @@
|
|
|
## Getting Help
|
|
## Getting Help
|
|
|
|
|
|
|
|
If you encounter any issues installing or using NetBox, try one of the
|
|
If you encounter any issues installing or using NetBox, try one of the
|
|
|
-following resources to get assistance. Please **do not** open a GitHub
|
|
+following resources to get assistance. Please **do not** open a GitHub issue
|
|
|
-issue except to report bugs or request features.
|
|
+except to report bugs or request features.
|
|
|
|
|
|
|
|
### Mailing List
|
|
### Mailing List
|
|
|
|
|
|
|
@@ -13,35 +13,32 @@ installation. You can find us [here](https://groups.google.com/forum/#!forum/net
|
|
|
### Freenode IRC
|
|
### Freenode IRC
|
|
|
|
|
|
|
|
For real-time discussion, you can join the #netbox channel on [Freenode](https://freenode.net/).
|
|
For real-time discussion, you can join the #netbox channel on [Freenode](https://freenode.net/).
|
|
|
-You can connect to Freenode at irc.freenode.net using an IRC client, or
|
|
+You can connect to Freenode at irc.freenode.net using an IRC client, or you can
|
|
|
-you can use their [webchat client](https://webchat.freenode.net/).
|
|
+use their [webchat client](https://webchat.freenode.net/).
|
|
|
|
|
|
|
|
## Reporting Bugs
|
|
## Reporting Bugs
|
|
|
|
|
|
|
|
* First, ensure that you've installed the [latest stable version](https://github.com/digitalocean/netbox/releases) of
|
|
* First, ensure that you've installed the [latest stable version](https://github.com/digitalocean/netbox/releases) of
|
|
|
-NetBox. If you're running an older version, it's possible that the bug
|
|
+NetBox. If you're running an older version, it's possible that the bug has
|
|
|
-has already been fixed.
|
|
+already been fixed.
|
|
|
-
|
|
+
|
|
|
-* Next, check the GitHub [issues list](https://github.com/digitalocean/netbox/issues) to see if the bug you've found has
|
|
+* Next, check the GitHub [issues list](https://github.com/digitalocean/netbox/issues) to see if the bug you've found has already
|
|
|
-already been reported. If you think you may be experiencing a reported
|
|
+been reported. If you think you may be experiencing a reported issue that
|
|
|
-issue that hasn't already been resolved, please click "add a reaction"
|
|
+hasn't already been resolved, please click "add a reaction" in the top right
|
|
|
-in the top right corner of the issue and add a thumbs up (+1). You might
|
|
+corner of the issue and add a thumbs up (+1). You mightalso want to add a
|
|
|
-also want to add a comment describing how it's affecting your
|
|
+comment describing how it's affecting your installation. This will allow us to
|
|
|
-installation. This will allow us to prioritize bugs based on how many
|
|
+prioritize bugs based on how many users are affected.
|
|
|
-users are affected.
|
|
+
|
|
|
-
|
|
+* If you haven't found an existing issue that describes your suspected bug,
|
|
|
-* If you haven't found an existing issue that describes your suspected
|
|
+please inquire about it on the mailing list. **Do not** file an issue until you
|
|
|
-bug, please inquire about it on the mailing list. **Do not** file an
|
|
+have received confirmation that it is in fact a bug. Invalid issues are very
|
|
|
-issue until you have received confirmation that it is in fact a bug.
|
|
+distracting and slow the pace at which NetBox is developed.
|
|
|
-Invalid issues are very distracting and slow the pace at which NetBox is
|
|
+
|
|
|
-developed.
|
|
+* When submitting an issue, please be as descriptive as possible. Be sure to
|
|
|
-
|
|
+include:
|
|
|
-* When submitting an issue, please be as descriptive as possible. Be
|
|
|
|
|
-sure to include:
|
|
|
|
|
|
|
|
|
|
* The environment in which NetBox is running
|
|
* The environment in which NetBox is running
|
|
|
- * The exact steps that can be taken to reproduce the issue (if
|
|
+ * The exact steps that can be taken to reproduce the issue (if applicable)
|
|
|
- applicable)
|
|
|
|
|
* Any error messages generated
|
|
* Any error messages generated
|
|
|
* Screenshots (if applicable)
|
|
* Screenshots (if applicable)
|
|
|
|
|
|
|
@@ -49,71 +46,64 @@ sure to include:
|
|
|
The issue will be reviewed by a moderator after submission and the appropriate
|
|
The issue will be reviewed by a moderator after submission and the appropriate
|
|
|
labels will be applied.
|
|
labels will be applied.
|
|
|
|
|
|
|
|
-* Keep in mind that we prioritize bugs based on their severity and how
|
|
+* Keep in mind that we prioritize bugs based on their severity and how much
|
|
|
-much work is required to resolve them. It may take some time for someone
|
|
+work is required to resolve them. It may take some time for someone to address
|
|
|
-to address your issue.
|
|
+your issue.
|
|
|
|
|
|
|
|
## Feature Requests
|
|
## Feature Requests
|
|
|
|
|
|
|
|
-* First, check the GitHub [issues list](https://github.com/digitalocean/netbox/issues) to see if the feature you're
|
|
+* First, check the GitHub [issues list](https://github.com/digitalocean/netbox/issues) to see if the feature you're requesting
|
|
|
-requesting is already listed. (Be sure to search closed issues as well,
|
|
+is already listed. (Be sure to search closed issues as well, since some
|
|
|
-since some feature requests are rejected.) If the feature you'd like to
|
|
+feature requests have been rejected.) If the feature you'd like to see has
|
|
|
-see has already been requested, click "add a reaction" in the top right
|
|
+already been requested and is open, click "add a reaction" in the top right
|
|
|
-corner of the issue and add a thumbs up (+1). This ensures that the
|
|
+corner of the issue and add a thumbs up (+1). This ensures that the issue has
|
|
|
-issue has a better chance of making it onto the roadmap. Also feel free
|
|
+a better chance of receiving attention. Also feel free to add a comment with
|
|
|
-to add a comment with any additional justification for the feature.
|
|
+any additional justification for the feature. (However, note that comments with
|
|
|
-(However, note that comments with no substance other than a "+1" will be
|
|
+no substance other than a "+1" will be deleted. Please use GitHub's reactions
|
|
|
-deleted. Please use GitHub's reactions feature to indicate your
|
|
+feature to indicate your support.)
|
|
|
-support.)
|
|
+
|
|
|
-
|
|
+* Due to an excessive backlog of feature requests, we are not currently
|
|
|
-* While suggestions for new features are welcome, it's important to
|
|
+accepting any proposals which substantially extend NetBox's functionality
|
|
|
-limit the scope of NetBox's feature set to avoid feature creep. For
|
|
+beyond its current feature set. This includes the introduction of any new views
|
|
|
-example, the following features would be firmly out of scope for NetBox:
|
|
+or models which have not already been proposed in an existing feature request.
|
|
|
-
|
|
|
|
|
- * Ticket management
|
|
|
|
|
- * Network state monitoring
|
|
|
|
|
- * Acting as a DNS server
|
|
|
|
|
- * Acting as an authentication server
|
|
|
|
|
|
|
|
|
|
* Before filing a new feature request, consider raising your idea on the
|
|
* Before filing a new feature request, consider raising your idea on the
|
|
|
-mailing list first. Feedback you receive there will help validate and
|
|
+mailing list first. Feedback you receive there will help validate and shape the
|
|
|
-shape the proposed feature before filing a formal issue.
|
|
+proposed feature before filing a formal issue.
|
|
|
|
|
|
|
|
-* Good feature requests are very narrowly defined. Be sure to enumerate
|
|
+* Good feature requests are very narrowly defined. Be sure to thoroughly
|
|
|
-specific functionality and data schema. The more effort you put into
|
|
+describe the functionality and data model(s) being proposed. The more effort
|
|
|
-writing a feature request, the better its chance is of being
|
|
+you put into writing a feature request, the better its chance is of being
|
|
|
implemented. Overly broad feature requests will be closed.
|
|
implemented. Overly broad feature requests will be closed.
|
|
|
|
|
|
|
|
* When submitting a feature request on GitHub, be sure to include the
|
|
* When submitting a feature request on GitHub, be sure to include the
|
|
|
following:
|
|
following:
|
|
|
|
|
|
|
|
* A detailed description of the proposed functionality
|
|
* A detailed description of the proposed functionality
|
|
|
- * A use case for the feature; who would use it and what value it
|
|
+ * A use case for the feature; who would use it and what value it would add
|
|
|
- would add to NetBox
|
|
+ to NetBox
|
|
|
- * A rough description of changes necessary to the database schema
|
|
+ * A rough description of changes necessary to the database schema (if
|
|
|
- (if applicable)
|
|
+ applicable)
|
|
|
- * Any third-party libraries or other resources which would be
|
|
+ * Any third-party libraries or other resources which would be involved
|
|
|
- involved
|
|
+
|
|
|
-
|
|
+* Please avoid prepending any sort of tag (e.g. "[Feature]") to the issue
|
|
|
-* Please avoid prepending any sort of tag (e.g. "[Feature]") to the issue title.
|
|
+title. The issue will be reviewed by a moderator after submission and the
|
|
|
-The issue will be reviewed by a moderator after submission and the appropriate
|
|
+appropriate labels will be applied.
|
|
|
-labels will be applied.
|
|
|
|
|
|
|
|
|
|
## Submitting Pull Requests
|
|
## Submitting Pull Requests
|
|
|
|
|
|
|
|
-* Be sure to open an issue before starting work on a pull request, and
|
|
+* Be sure to open an issue before starting work on a pull request, and discuss
|
|
|
-discuss your idea with the NetBox maintainers before beginning work.
|
|
+your idea with the NetBox maintainers before beginning work. This will help
|
|
|
-This will help prevent wasting time on something that might we might not
|
|
+prevent wasting time on something that might we might not be able to implement.
|
|
|
-be able to implement. When suggesting a new feature, also make sure it
|
|
+When suggesting a new feature, also make sure it won't conflict with any work
|
|
|
-won't conflict with any work that's already in progress.
|
|
+that's already in progress.
|
|
|
|
|
|
|
|
-* When submitting a pull request, please be sure to work off of the
|
|
+* When submitting a pull request, please be sure to work off of the `develop`
|
|
|
-`develop` branch, rather than `master`. In NetBox, the `develop` branch
|
|
+branch, rather than `master`. The `develop` branch is used for ongoing
|
|
|
-is used for ongoing development, while `master` is used for tagging new
|
|
+development, while `master` is used for tagging new stable releases.
|
|
|
-stable releases.
|
|
|
|
|
|
|
|
|
|
-* All code submissions should meet the following criteria (CI will
|
|
+* All code submissions should meet the following criteria (CI will enforce
|
|
|
-enforce these checks):
|
|
+these checks):
|
|
|
|
|
|
|
|
* Python syntax is valid
|
|
* Python syntax is valid
|
|
|
* All tests pass when run with `./manage.py test`
|
|
* All tests pass when run with `./manage.py test`
|
Jeremy Stretch