Code of Practice for Development - EXA-UQ/EXAUQ-Toolbox GitHub Wiki

When contributing to the code in this repository, please adhere to the following practices.

Source code

Docstrings should be written in the Numpy format.

  • The docstring for a class should also serve as documentation for the class's __init__ method. As such, there is no need for a separate docstring for __init__.

We use type hinting throughout the codebase.

Dependency management

Third party package dependencies should be updated fortnightly.

Git / GitHub

Branches should be deleted when the associated PR is merged.