Skip to content

Commit 29bee78

Browse files
committed
precommit command documentation
1 parent 75a6a4d commit 29bee78

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ A CS+SG project for the Undergraduate Senate at UNC Chapel Hill.
55
## Contributors
66

77
| Name | Role |
8-
| ------------- | --------------- |
8+
| --------------- | --------------- |
99
| Caleb Han | Tech Lead |
1010
| Mason Mines | Project Manager |
1111
| Xander Pak | Developer |
@@ -83,6 +83,12 @@ cd ../backend
8383
cp .env.example .env # duplicates the template and renames it to .env
8484
```
8585

86+
Run pre-commit checks locally
87+
88+
```bash
89+
pre-commit run --all-files # make sure to run this command before making any commits to ensure code quality and consistency
90+
```
91+
8692
Or you can do the actions manually. Then,
8793

8894
- Ensure you have Docker and the Dev Containers extension installed

0 commit comments

Comments
 (0)