From 9acd0e99f99c3a5ec5214e60b491fa517f70aadf Mon Sep 17 00:00:00 2001 From: Matt Layher Date: Tue, 28 Jun 2016 10:55:38 -0400 Subject: [PATCH] Add sanity check checklist for submitting pull requests --- CONTRIBUTING.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3c36885ea..f437d2516 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,8 +49,14 @@ Even if it's not quite right for NetBox, we may be able to point you to a tool b * A rough description of any changes necessary to the database schema (if applicable) * Any third-party libraries or other resources which would be involved -# Submitting Pull Requests +## Submitting Pull Requests -When submitting a pull request, please be sure to work off of branch `develop`, rather than branch `master`. +* When submitting a pull request, please be sure to work off of branch `develop`, rather than branch `master`. In NetBox, the `develop` branch is used for ongoing development, while `master` is used for tagging new stable releases. + +* All code submissions should meet the following criteria (CI will enforce these checks): + + * Python syntax is valid + * All tests pass when run with `./manage.py test netbox/` + * PEP 8 compliance is enforced, with the exception that lines may be greater than 80 characters in length