Skip to content

Contributing to the App

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, and pydocstyle.
  • 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.

Branching Policy

The branching policy includes the following tenets:

  • The develop branch is the branch of the next major and minor paired version planned.
  • PRs intended to add new features should be sourced from the develop branch.

Nautobot Data Validation Engine will observe semantic versioning, as of 1.0. This may result in an quick turn around in minor versions to keep pace with an ever growing feature set.

Release Policy

Nautobot Data Validation Engine has currently no intended scheduled release schedule, and will release new features in minor versions.

When a new release, from develop to main, is created the following should happen.

  • A release PR is created with:
  • Update to the changelog in docs/admin/release_notes/version_<major>.<minor>.md file to reflect the changes.
  • Change the version from <major>.<minor>.<patch>-beta to <major>.<minor>.<patch> in pyproject.toml.
  • Set the PR to the proper branch main.
  • Ensure the tests for the PR pass.
  • Merge the PR.
  • Create a new tag:
  • The tag should be in the form of v<major>.<minor>.<patch>.
  • The title should be in the form of v<major>.<minor>.<patch>.
  • The description should be the changes that were added to the version_<major>.<minor>.md document.
  • If merged into main, then push from main to develop, in order to retain the merge commit created when the PR was merged
  • A post release PR is created with.
  • Change the version from <major>.<minor>.<patch> to <major>.<minor>.<patch + 1>-beta in both pyproject.toml and nautobot.__init__.__version__.
  • Set the PR to the proper branch, develop.
  • Once tests pass, merge.