Get involved

If you would like to contribute to the development of hazen and get involved with the project, we suggest you:

Start by creating a new issue for the feature and:
- decide which release this is for
- gather any user research
- define acceptance test criteria
Create a Git feature-branch for this ticket
Create an empty file detailing the design in the file docstring
Create an empty file detailing unit, integration and system tests, where appropriate
Create pull request and get the design approved
Code according to approved design and acceptance criteria
Keep an eye on the feedback from Bitbucket Pipelines and Sonarcube
Check a running instance of your app by locally running the latest Docker:
```
image:docker run --rm -p5000:5000 -it
```
Once you’re satisfied with the new feature, the pull request can be formally reviewed for merging

Changing DB models

Remember to to generate migration script by running:

__flask db migrate -m "very short commit message"__

To run local, install sonar-scanner. Edit properties file in conf so that url is pointing to cloud instance.

Produce requirements.txt by running:

__pipreqs --force --savepath ./requirements.txt --ignore bin,hazen-venv ./__

Check what requirements have been edited as pipreqs is not perfect e.g. scikit_image instead of skimage
Make sure all tests are passing
Update version in hazenlib/\_\_init\_\_.py, remove dev.
Update docs (we use sphinx-apidoc for autodocumentation of modules)