Before/During PR#

Prior to opening a pull request, ensure that your code has been auto-formatted, and that it passes both the tests and lint checks.

Format#

We use black formatter to format our code.

Before you commit your changes, make sure you run the following command from the root directory:

black truelearn

It will automatically format your code.

Make sure you follow the instructions on Testing the library to test your changes.

If you aim at fixing a bug, remember to add at least one new test case for the bug you found.

If you aim at providing some new functionalities, make sure you have fully tested them, which means you should aim for 100% test coverage.

Make sure you follow the instructions on Testing the library to lint your changes.

You are now ready to ship your PR! 🚀

Note: If you are a member of the core maintainer team, make sure you check the next section about how to release TrueLearn.