readme / makefile

CONTRIBUTING.md

@@ -7,3 +7,21 @@ If you're looking to contribute, please:
 - add your feature or improvement.
 - send a pull request.
 - we appreciate your input!
+
+## Running Tests
+
+Before submitting a pull request, please run the tests and linter:
+
+```shell
+make check test
+```
+
+Right now the linting rules are from an off-the-shelf config, and many rules are still being refined/removed. Well-justified per-file or per-rule ignores are welcome.
+
+You can run
+
+```shell
+make githooks
+```
+
+to install a git pre-push hook that will run the checks before pushing.

Makefile

@@ -78,3 +78,11 @@ test-examples:
 	: 🧠 OpenAI
 	:
 	docker compose -f examples/openai_client/docker-compose.yaml run examples
+
+.PHONY: githooks
+githooks:
+	:
+	: 🚀 Installing pre-push hook
+	:
+	echo 'make check test' > .git/hooks/pre-push
+	chmod +x .git/hooks/pre-push