You want to contribute? That's awesome. Thank you! Things can only get better from here.
The model is tested with Python's unittest framework. Please write new tests (where applicable) for any code you create. The repository is linked to Circleci's CI tool so any commited code will be built and run automatically and test results will be visible both on the branch and when pull requests are made.
To locally test the model and/or any changes you make to the source code, set your working directory to the root of the project py_SBeLT/ and run the following
python3 -m unittest discover -s src/tests --bufferIf you see an 'OK' at the bottom of the output that means all the tests have passed. If you would like to test the code and have the stdout and stderr from passing tests be displayed, run the same command without the --buffer flag.
Once you're ready to submit code, please create a pull request that clearly outlines the changes you've made. Additionally, when committing code please use clear commit messages describing the feature being committed. This helps keep track of changes to the project and makes reviews much easier!
- Docstrings are written in accordance with Google Python Style Guide
- If you think the code isn't simple enough to understand alone, write comments!
- Use tabs for spacing (I know, I know...)
- Any logic related to the model should exist in
logic.py - Keep variable/function/class names in line with the vocabulary described in
docs/NOMECULTURE.md