Our software engineering practices

[tommylees112]

1. Run pytest and mypy locally before committing to github.

2. Each function should have a descriptive name and perform one task. An exception is potentially pipeline type functions that run the process functions in a particular order

3. Docstrings are standardized:

• only have docstrings for functions the users will interact with
• A description at the beginning
• Input arguments (or the class attributes)
• What the function returns

4. Using static typing wherever possible

[tommylees112]

(all credit to @gabrieltseng - more a note to self than anything else)

[tommylees112]

Running pytest:

into the command line in the project root just type:

$ pytest

If there are issues with flake8 see here)

[tommylees112]

Running mypy

$ mypy src

[tommylees112]

When do you know if you're ready for a PR?