Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

37 lines (26 loc) · 1.15 KB
Raw

Contributing

Contributing to HydraGNN is easy: just open a pull request. Make master the destination branch on the HydraGNN repository and allow edits from maintainers in the pull request.

Your pull request must pass HydraGNN's tests, be formatted to match HydraGNN, and be reviewed by at least one HydraGNN developer.

Additional dependencies are needed for formatting and testing:

pip install -r requirements-dev.txt

Automatic commit checking

You can use pre-install to ensure everything is ready to be submitted in a pull request. Once pip installed, pre-commit must be installed once (only the first time being used): pre-commit install. Formatting checks are then run for every commit.

PRE_COMMIT_ALLOW_NO_CONFIG=1 git commit ... can be used to selectively skip these checks.

Checks can instead be done manually, described below.

Code formatting

HydraGNN is formatted with black. You should run black . from the top level directory.

Unit testing

HydraGNN uses pytest to test. You can run python -m pytest from the top level directory.