Contributions to the repository are welcome, and we encourage you to open issues and pull requests. In general, it is recommended to fork this repository and open a pull request from your fork to the trunk branch. PRs are encouraged to be short and focused, and to include tests and documentation where appropriate.
To install the developers dependencies run:
pip install -e '.[dev]' --find-links https://data.pyg.org/whl/torch-2.1.2+cu121.html
Dependencies are defined in pyproject.toml, and frozen versions that are known to work are provided in requirements/.
To regenerate the frozen versions, run ./generate_requirements.sh <ENV-NAME>. See comments within.
We use tox to run tests and linting, and pre-commit to run checks before committing.
To ensure that these checks pass, simply run tox -e style and tox run to run linters and tests, respectively.
tox itself runs many linters, but the most important ones are black, ruff, isort, and mypy. The full list
of linting tools is found in .pre-commit-config.yaml, while tox.ini defines the environments under which these
linters (as well as tests) are run.
We use Github Actions to run tests and linting on every push and pull request. The configuration for these actions is found in .github/workflows/.
The cascade of events is as follows:
- For
build-and-test,tox -> testenv:py310 -> pytestis run. - For
code-quality,tox -e style -> testenv:style -> pre-commit -> {isort, black, mypy, bandit, ruff, & others}. This and the "others" are defined in.pre-commit-config.yamland include things like checking for secrets and trailing whitespace.
On top of black-as-a-style-guide, we generally adhere to the Google Python Style Guide.
Our docstrings follow the numpydoc format, and we use type hints throughout the codebase.