Skip to content

Commit d9936c5

Browse files
committed
Add info about installation approach
1 parent fd64d38 commit d9936c5

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

.pre-commit-config.yaml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,14 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
# Summary: optional configuration for using pre-commit with the OpenFermion
16-
# project. It is not run by default by the check scripts; to use it, you need
17-
# to install pre-commit (https://pre-commit.com/).
15+
# Summary: config for setting up git hooks using the pre-commit framework. This
16+
# is optional and NOT set up by default nor used by the scripts in check/. Here
17+
# is a suggested installation approach; after doing this, the pre-commit hooks
18+
# will be called automatically by git at the appropriate times:
19+
#
20+
# pip install pre-commit
21+
# pre-commit install -t pre-commit -t commit-msg -t pre-push
22+
# pre-commit run
1823

1924
default_language_version:
2025
python: 'python3.11'

0 commit comments

Comments
 (0)