Add note about pre-commit hook
authorJelte Fennema-Nio <[email protected]>
Thu, 19 Dec 2024 19:21:35 +0000 (20:21 +0100)
committerMagnus Hagander <[email protected]>
Fri, 10 Jan 2025 15:15:15 +0000 (16:15 +0100)
README.md
dev_requirements.txt

index 61537749fe44f8df57f6d9a5add5d0769c774eee..a379f53d0021c9ffc9e822f118d5a581adc662d9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -59,3 +59,13 @@ Finally, you're ready to start the application:
 
 Then open http://localhost:8007/admin to log in. Once redirected to the Django
 admin interface, go back to the main interface. You're now logged in.
+
+## Contributing
+
+Before committing make sure to install the git pre-commit hook to adhere to the
+codestyle.
+
+```bash
+ln -s ../../tools/githook/pre-commit .git/hooks/
+
+```
index 3b878a3b86c5513e3f24932f206abedf1e198fe6..cedd81ce7e48f0b1a5830bbb8da85d78f9165d80 100644 (file)
@@ -1,2 +1,3 @@
 -r requirements.txt
 uwsgi
+pycodestyle