Skip to content

Commit 8493c54

Browse files
committed
docs: add instructions for pre-commit
1 parent c5e57a8 commit 8493c54

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,3 +92,22 @@ When contributing to the `stack/` directory:
9292
- **Document any new overlays** or configurations in the [DEPLOYMENT.md](DEPLOYMENT.md) guide
9393
- **Test deployments** on both OpenShift or Kubernetes when possible
9494
- **Include resource requirements** in documentation
95+
96+
### pre-commit
97+
98+
This project is configured to use pre-commit for every new PR.
99+
You can find instructions for installing pre-commit [here](https://pre-commit.com/#installation)
100+
101+
## Setup pre-commit for the RAG project
102+
103+
Run the following command to allow pre-commit to run before each commit:
104+
105+
``` bash
106+
pre-commit install
107+
```
108+
109+
To run pre-commit without commiting run:
110+
111+
``` bash
112+
pre-commit run --all-files
113+
```

0 commit comments

Comments
 (0)