From b7d1cf51f8d9affc1ab4ce08e773a85af8235f7e Mon Sep 17 00:00:00 2001 From: Brad Macdonald Date: Thu, 21 Dec 2023 10:02:44 -0700 Subject: [PATCH] updates contributing --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8c8ba6f7..8d4cffbf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -85,10 +85,12 @@ This package uses [semantic versioning](https://semver.org/) for releasing new v ### Pre-Commit Hooks -This repository uses a number of `pre-commit` hooks to enforce our standard formatting. Before committing changes, make sure to run the following: +This repository uses a number of `pre-commit` hooks to enforce our formatting standards. Before committing changes, make sure to run the following (assuming development dependencies are already installed): + ``` pre-commit run --all-files ``` + Some needed changes will be done automatically by the pre-commit hooks. In other cases, you may need to make changes manually. Ensure that all `pre-commit`` hooks pass locally. Our GitHub Actions CI pipeline will run these hooks automatically and Pull Requests will not be able to be merged unless all hooks pass. ### Testing