doc: Move contributing docs into default makefile target

untitaker · untitaker · commit c359d695e6ae · 2019-03-12T22:34:52.000+01:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -7,20 +7,10 @@ changes manually.
 ## Running tests and linters
 
 Make sure you have `virtualenv` installed, and the Python versions you care
-about. You should have at least one version of Python 2 and Python 3 installed.
+about. You should have Python 2.7 and the latest Python 3 installed.
 
 You don't need to `workon` or `activate` anything, the `Makefile` will create
-one for you.
-
-* Running basic tests without integrations: `make test` (Python 2.7 and 3.7)
-* Running all tests: `make test-all`
-
-  This really runs all tests, for all integrations, for all version
-  combinations we care about. This is the closest you can get to the CI build,
-  provided you have all relevant Python versions installed.
-
-* Running linting: `make check` or `make lint`
-* Running autoformatting: `make format`
+one for you. Run `make` or `make help` to list commands.
 
 ## Releasing a new version
 
diff --git a/Makefile b/Makefile
@@ -2,6 +2,17 @@ SHELL = /bin/bash
 
 VENV_PATH = .venv
 
+help:
+	@echo "Thanks for your interest in the Sentry Python SDK!"
+	@echo
+	@echo "make lint: Run linters"
+	@echo "make test: Run basic tests (not testing most integrations)"
+	@echo "make test-all: Run ALL tests (slow, closest to CI)"
+	@echo "make format: Run code formatters (destructive)"
+	@echo
+	@echo "Also make sure to read ./CONTRIBUTING.md"
+	@false
+
 .venv:
 	virtualenv $(VENV_PATH)
 	$(VENV_PATH)/bin/pip install tox
@@ -25,7 +36,7 @@ test-all: .venv
 	@TOXPATH=$(VENV_PATH)/bin/tox sh ./scripts/runtox.sh
 .PHONY: test-all
 
-check: lint
+check: lint test
 .PHONY: check
 
 lint: .venv
