Add Makefile for development shortcuts

Use standard commands (dev, lint, test) for development -- reduces the need to check the README for repository-specific commands.
valohai · Aug 17, 2023 · a60ca85 · a60ca85
1 parent dbeef7c
commit a60ca85
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 4 deletions.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,16 @@
+.PHONY: help
+help:
+	@echo "check README for usage"
+
+.PHONY: dev
+dev:
+	pip install -e . -r requirements-test.txt pre-commit
+	pre-commit install
+
+.PHONY: lint
+lint:
+	pre-commit run --all-files
+
+.PHONY: test
+test:
+	pytest
diff --git a/README.md b/README.md
@@ -54,12 +54,11 @@ print(config.steps['cool step'].command)
 
 ```bash
 # setup development dependencies
-pip install -e . -r requirements-test.txt pre-commit
-pre-commit install
+make dev
 
 # run linting and type checks
-pre-commit run --all-files
+make lint
 
 # run tests
-pytest
+make test
 ```