When contributing to this repository, please first discuss the change you wish to make via an issue, email, or any other method with the owners of this repository before making the change.
Useful tools for the project include, but are not limited to:
The project is scanned for lint by a post commit action. Using these tools in an IDE will help to keep the project lint free.
When checking out the repository, please run npm prepare in the root folder. This will install
the conventional commit tools that we use to automate changelog attributes. git commit will then
be directed to provide a commit template for guidance in structuring the commit message. If well
formatted, these will appear directly in the changelog.
- No sensitive information should be included in any commit. This includes passwords or secrets for any environment
- Open a pull request and complete the template explaining the feature, the changes made, and the tests performed
- Ensure that no lint is added to the project
- Ensure that all unit tests pass
- Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
- You may merge the Pull Request in once you have the sign-off of other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.