theochem/ModelHamiltonian

Use of pre-commit hooks not specified in README.md or requirement.txt file

Closed this issue · 2 comments

This repository uses pre-commit hooks for upstream commit validation, but this has not been included in the README.md or requirement.txt files.
It can be frustrating for any beginner contributor to see some github workflow check fails because of pre-commit.

  • Steps to reproduce the issues:
    Make a Pull request to this repo without configuring pre-commit will throw errors in gihub workflows.
    image

I suggest we have a small section on how to install pre-commit and get started with this project.

In the long run, we should also add instructions on pre-commit.ci to the Guidelines Repository. It is, for now, an essential part of our workflow for most of our (newer) repositories.

I think this is done!