Skip to content

Commit

Permalink
Updated README - pre-commit config
Browse files Browse the repository at this point in the history
  • Loading branch information
sean-morris committed Nov 3, 2024
1 parent 88cb2a9 commit 5296643
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,15 @@ editing, testing, building and deploying hubs.
The other python package definition file, `requirements.txt` is used solely by
our Github Actions CI/CD pipeline.

## Pre-Commit hooks: Installing

The previous step, `pip install -r dev-requirements.txt`, installs the package, pre-commit.
This is used to run a series of commands defined in the file, .pre-commit-config.yaml, to help ensure no mistakes are committed to the repo.

After the pip install command execute the following:
-- `pre-commit install`
-- `pre-commit run --all-files`

## Setting up your fork and clones

First, go to your [github profile settings](https://github.com/settings/keys)
Expand Down

0 comments on commit 5296643

Please sign in to comment.