Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README - pre-commit config #6450

Merged
merged 1 commit into from
Nov 3, 2024
Merged

Updated README - pre-commit config #6450

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
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
Loading