Added provisory pre-commit hooks

qc2nl / qc2

Facilitate the orchestration of quantum chemistry applications on quantum computers

https://qc2.readthedocs.io/

Apache License 2.0

3 stars 2 forks source link

Closed Cmurilochem closed 1 year ago

Cmurilochem commented 1 year ago

Initial attempt to include pre-commit hooks as previously discussed. Further updates to come.

Cmurilochem commented 1 year ago

The following pre-commit hooks have been added:

Standard pre-commit checks like: whitespace trailing, end of file newline, file size restriction.
Pydocstyle that checks the existence of proper docstrings and ensure that they respect google format.
Flake8 linting tool which checks for errors, styling issues (pep8) and circular complexity.

Maybe theses tests are too severe for the moment ? I am open to suggestions.

NicoRenaud commented 1 year ago

Look good carlos ! I'll merge that as well 👍