Skip to content

Commit d070301

Browse files
committed
Add codeformatting info to readme
1 parent 3d63e9f commit d070301

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -76,14 +76,20 @@ admin interface, go back to the main interface. You're now logged in.
7676

7777
## Contributing
7878

79-
Before committing make sure to install the git pre-commit hook to adhere to the
80-
codestyle.
79+
Code formatting and linting is done using [`ruff`] and [`biome`]. You can run
80+
formatting using `make format`. Linting can be done using `make lint` and
81+
automatic fixing of linting errors can be done using `make lint-fix`. CI checks
82+
that you adhere to these coding standards.
83+
84+
You can install the git pre-commit hook to help you adhere to the codestyle:
8185

8286
```bash
8387
ln -s ../../tools/githook/pre-commit .git/hooks/
84-
8588
```
8689

90+
[`ruff`]: https://docs.astral.sh/ruff/)
91+
[`biome`]: https://biomejs.dev/
92+
8793
If you'd like to regenerate the database dump files, you can run the following commands:
8894
```
8995
./manage.py dumpdata auth --format=json --indent=4 --exclude=auth.permission > pgcommitfest/commitfest/fixtures/auth_data.json

0 commit comments

Comments
 (0)