From e065a5ef677f74f2c858858e27a82c15a9d6bb84 Mon Sep 17 00:00:00 2001 From: Gustavo Matias <681278+gumatias@users.noreply.github.com> Date: Sun, 3 Jan 2021 21:52:04 -0800 Subject: [PATCH] Emphasize installing dependencies before testing As a beginner in Python it wasn't clear that `poetry install` needed to be run before `make test` for instance. That threw a sort of obscure error until I figured it out what the solution was. This is extremely minor, but make sure installing dependencies is the very first instruction can reduce some friction when contributing. --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4bf19932..1f5e691a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -85,9 +85,9 @@ You can find an inventory of commands in the `makefile`. \*nix users can run the A typical development workflow includes: + * Installing dependencies: `poetry install` * Running tests: `make test` * Running the source in a virtual environment: - * `poetry install` * `poetry shell` * `jrnl` (with or without arguments as necessary) * Linting the code to standardize its style: `make lint`