Contributing to the App¶
Developer Note - Remove Me!
Information on how to contribute fixes, functionality, or documentation changes back to the project.
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, andpydocstyle. - YAML linting is done with
yamllint. - Django unit test to ensure the plugin 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¶
Developer Note - Remove Me!
What branching policy is used for this project and where contributions should be made.
Release Policy¶
Developer Note - Remove Me!
How new versions are released.