Ensure you have read any appropriate documentation for using or developing S.M.I.B. in the readme
Open our issue tracker and create a new issue giving us much detail about the bug as possible, how to recreate it, what outcome you expected vs what outcome you got. You can label this issue with the "bug" label.
If you have a new idea, create an issue with details of what you would like to see and why it would be helpful and tag the issue with the "enhancement" label.
If you would like to contribute some code back to the project you are welcome to make a pull request. Ensure an issue exists for your proposed patch and drop a comment in there to let us know you are working on it. Create a fork of the repository, create a new branch for your patch and use that branch to raise a pull request. See the github documentation for more information.
In general we follow pep8 guidelines.
Code should be clear in its intent with minimal comments, ensure you use helpful variable and function names and keep functions and methods simple in their scope. More well named simple functions are better than monolithic complex functions with short and cryptic names.
A code update should almost always trigger an update or creation of new documentation; Ensure associated documentation is updated whenver possible with new code patches.
We haven't got tests yet, but if we do it will be pytest, feel free to provide pytetss for your patch.
Pull requests will be reviewed by repo admins (code club) at SoMakeIt and providing at least one repo admin approves a review, the code can be merged into the develop branch ahead of a release into master (and production environment) once fully tested.