Skip to content

Commit

Permalink
feat(RHINENG-5460): Add rh-pre-commit installation instructions to RE…
Browse files Browse the repository at this point in the history
…ADME (#1576)

* Add instructions for rh-pre-commit

* Add reminder about testing the installation

* Replace internal URL
  • Loading branch information
kruai authored Dec 11, 2023
1 parent e82471f commit 34f1efa
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,10 @@ pre-commit install
```

After that, all your commited files will be linted. If the checks don’t succeed, the commit will be rejected, but the altered files from the linting will be ready for you to commit again if the issue was automatically correctable.

If you're inside the Red Hat network, please also make sure you have rh-pre-commit installed; instructions on installation can be found [here](https://url.corp.redhat.com/rh-pre-commit#quickstart-install). Then, verify the installation by following the [Testing the Installation](https://url.corp.redhat.com/rh-pre-commit#testing-the-installation) section.
If you follow the instructions for Quickstart Install, and then re-enable running hooks in the repo's `.pre-commit-config.yaml` (instructions in the [Manual Install section](https://url.corp.redhat.com/rh-pre-commit#manual-install)), both hooks should run upon making a commit.

Please make sure all checks pass before submitting a pull request. Thanks!

## Running the server locally
Expand Down

0 comments on commit 34f1efa

Please sign in to comment.