Contributions of any kind are always welcome.
If you feel like adding to the code, you can simply issue a pull request. If you do so, please, try to adhere to micropython
's coding conventions.
However, you can also contribute to the documentation (preferably via the jupyter notebooks.
If you decide to lend a hand with testing, here are the steps:
- Write a test script that checks a particular function, or a set of related functions!
- Drop this script in one of the folders in ulab tests!
- Run the ./build.sh script in the root directory of
ulab
! This will clone the latestmicropython
, compile the firmware forunix
, execute all scripts in theulab/tests
, and compare the results to those in the expected results files, which are also inulab/tests
, and have an extension.exp
. In case you have a new snippet, i.e., you have no expected results file, or if the results differ from those in the expected file, a new expected file will be generated in the root directory. You should inspect the contents of this file, and if they are satisfactory, then the file can be moved to theulab/tests
folder, alongside your snippet.