Skip to content

Commit

Permalink
updates contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
BWMac committed Dec 21, 2023
1 parent 3319eb0 commit b7d1cf5
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit b7d1cf5

Please sign in to comment.