From 1df6713ad584ea6e14563da3a4e8a0baf5853ba2 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 17 Oct 2019 20:56:37 -0400 Subject: [PATCH] Minor improvements pertaining to CII best practices --- CONTRIBUTING.md | 17 ++++++++++------- README.md | 12 +++++++++++- 2 files changed, 21 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1ecdbf1ac..55a979eef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,7 +24,7 @@ already been fixed. to see if the bug you've found has already been reported. If you think you may be experiencing a reported issue that hasn't already been resolved, please click "add a reaction" in the top right corner of the issue and add a thumbs -up (+1). You mightalso want to add a comment describing how it's affecting your +up (+1). You might also want to add a comment describing how it's affecting your installation. This will allow us to prioritize bugs based on how many users are affected. @@ -99,6 +99,8 @@ any work that's already in progress. * Any pull request which does _not_ relate to an accepted issue will be closed. +* All major new functionality must include relevant tests where applicable. + * When submitting a pull request, please be sure to work off of the `develop` branch, rather than `master`. The `develop` branch is used for ongoing development, while `master` is used for tagging new stable releases. @@ -128,15 +130,16 @@ If an issue is labeled as "status: revisions needed" a moderator has identified the issue itself and is asking for the submitter himself to update the original post with the requested information. If the original post is not updated in a reasonable amount of time, the issue will be closed as invalid. - + The core maintainers group has chosen to make use of the GitHub Stale bot to aid in issue management. - + * Issues will be marked as stale after 14 days of no activity. - * Then after 7 more days of inactivity, the issue will be closed. - -* Any issue with either the "status: accepted" or "status: gathering feedback" labels applied will be exempt from all Stale bot actions. - +* Any issue bearing one of the following labels will be exempt from all Stale bot actions: + * `status: accepted` + * `status: gathering feedback` + * `status: blocked` + It is natural that some new issues get more attention than others. Often this is a metric of an issues's overall usefulness to the project. In other cases in which issues merely get lost in the shuffle, notifications from Stale bot can bring renewed attention to potentially meaningful issues. diff --git a/README.md b/README.md index e915c8662..996f26332 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@ NetBox is an IP address management (IPAM) and data center infrastructure management (DCIM) tool. Initially conceived by the network engineering team at [DigitalOcean](https://www.digitalocean.com/), NetBox was developed specifically -to address the needs of network and infrastructure engineers. +to address the needs of network and infrastructure engineers. It is intended to +function as a domain-specific source of truth for network operations. NetBox runs as a web application atop the [Django](https://www.djangoproject.com/) Python framework with a [PostgreSQL](http://www.postgresql.org/) database. For a @@ -42,6 +43,15 @@ and run `upgrade.sh`. * [Ansible deployment](https://github.com/lae/ansible-role-netbox) (via [@lae](https://github.com/lae)) * [Kubernetes deployment](https://github.com/CENGN/netbox-kubernetes) (via [@CENGN](https://github.com/CENGN)) +# Providing Feedback + +Feature requests and bug reports must be submitted as GiHub issues. (Please be +sure to use the [appropriate template](https://github.com/netbox-community/netbox/issues/new/choose).) +For general discussion, please consider joining our [mailing list](https://groups.google.com/forum/#!forum/netbox-discuss). + +If you are interested in contributing to the development of NetBox, please read +our [contributing guide](CONTRIBUTING.md) prior to beginning any work. + # Related projects Please see [our wiki](https://github.com/netbox-community/netbox/wiki/Community-Contributions) for a list of relevant community projects.