Contributing¶
First of all, fork and clone the ADia.
cd path/to/adia
What you have to do before sending any pull request:
Pass All CPython tests
Ensure the code coverage factor remains at
100%.Pass Javascript tests
Lint
Doctest
Setup Development Environment¶
Use your favorite virtual environment tool such as https://pypi.org/project/virtualenvwrapper/.
In order, you need GNU Make to continue.
sudo apt install make
make env
Running CPython tests¶
make test
Coverage Result¶
make cover
Lint¶
make lint
Documentation¶
make doc
Generated HTML documentation can be found at documentation/build.
Live Documenetation¶
make livedoc
Now browse the http://localhost:8082.
Doctest¶
make doctest
Javascript Tests¶
Run:
make clean webclinic_serve
To build and serve the client side test files.
Then browse http://0.0.0.0:8000/check.html and wait to pass/fail tests.
Update Brython runtime¶
Run make cleanall to force the webclinic makefile rule to download and
update brython*.js files.
make cleanall webclinic
See also
