Coding practises

If you’d like to contribute your changes back to iDEA, please follow good coding practises.

Write unit tests

For any new feature you add, make sure to add a unit test that checks you feature is working as intended.

  • Naming convention: test_<your_module>.py
  • start by copying a simple example, e.g. test_NON.py
  • make sure your test is quick, it should run in the blink of an eye

Checklist

Before making a pull request, go through the following checklist:

  1. Check that you didn’t break the existing unit tests:

    # run this in the base directory
python -m unittest discover

  2. Check that the documentation builds fine:

    cd doc/
bash make_doc.sh

  3. Check the test coverage for your module (should be close to 100%):

    firefox doc/_build/coverage/index.html