Contributing

Any help to improve allowed is welcome and appreciated.

If you spot an error in the code or documentation, please check if it has been reported, before creating a new issue.

If you have an idea for a new feature, post it in the ideas discussion forum. If you have a query about using allowed, post it in the Q & A discussion forum.

If you are an M269 student or tutor, you can alternatively report errors, make suggestions and ask questions in the M269 technical forum.

If you use allowed in your course, we'd love to hear about your experience in the show & tell forum.

If you want to contribute code to address an open issue:

Install and activate the dsa-ou virtual environment.
Fork this repository to your GitHub account and then clone it to your disk.
Run python allowed.py sample.py > sample.txt (optionally with option -m if you installed pytype).
Run python allowed.py path/to/M269/book/python > book.txt.
Choose an open issue and assign it to yourself.
Create a branch in your repository to work on the issue.
Run the black and isort formatter on your modified allowed.py before testing it.
Check that your changes didn't modify allowed's behaviour:
1. run python allowed.py sample.py | diff -w - sample.txt
2. run python allowed.py path/to/M269/book/python | diff -w - book.txt
3. neither run should show any differences
Do any tests specific to the issue you're addressing.
Make a pull request.

Provide feedback