Contributing to the App¶
Pull requests are welcome and automatically built and tested against multiple version of Python and multiple version of Nautobot through GitHub Actions.
The project is packaged with a light development environment based on docker-compose
to help with the local development of the project and to run tests.
The project is following Network to Code software development guidelines and is leveraging the following:
- Python linting and formatting:
black
,pylint
,bandit
,flake8
, andruff
. - YAML linting is done with
yamllint
. - Django unit test to ensure the app is working properly.
Documentation is built using mkdocs. The Docker based development environment automatically starts a container hosting a live version of the documentation website on http://localhost:8001 that auto-refreshes when you make any changes to your local files.
Creating Changelog Fragments¶
All pull requests to next
or develop
must include a changelog fragment file in the ./changes
directory. To create a fragment, use your GitHub issue number and fragment type as the filename. For example, 2362.added
. Valid fragment types are added
, changed
, deprecated
, fixed
, removed
, and security
. The change summary is added to the file in plain text. Change summaries should be complete sentences, starting with a capital letter and ending with a period, and be in past tense. Each line of the change fragment will generate a single change entry in the release notes. Use multiple lines in the same file if your change needs to generate multiple release notes in the same category. If the change needs to create multiple entries in separate categories, create multiple files.
Example
Wrong
Right
Multiple Entry Example
This will generate 2 entries in the fixed
category and one entry in the changed
category.
Branching Policy¶
Please fork the release and add a new branch to your fork. Make changes to your branch in your fork and submit PRs from there.
Release Policy¶
New versions are released as bug fixes and features are introduced. We will make sure to release new versions to support the latest Nautobot versions as necessary.