Contributing Guidelines¶
Open a Pull Request¶
Please don’t hesitate to open a Pull Request if you have a fix for one of the issues .
Install a development environment¶
TODO
Test you code using pytest¶
TODO
Coding Guidelines¶
Following the guidelines below when contributing to the project would be appreciated
Language¶
- OpenSCHC’s code is in Python, targetting:
- micropython (https://micropython.org)
- the micropython variant for Pycom devices (`https://pycom.io/)
- Python 3 (on server/desktop)
Coding Style¶
You should loosely follow the google python style guide. However, the style should not be firstly coerced. All contributions will be appreciated.
Other advices¶
Please be aware of the Micropython restrictions and specificities compared to Python3 should you decide to run your code on constrained devices