fz0x1/jrnl
1
0
Fork 0
mirror of https://github.com/jrnl-org/jrnl.git synced 2025-05-10 16:48:31 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Emphasize installing dependencies before testing (#1148)

Browse source 
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.
This commit is contained in:
Gustavo Matias 2021-01-09 11:07:03 -08:00 • committed by GitHub
parent c155bafa84
commit 6980ed1906
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CONTRIBUTING.md
View file

@ -85,9 +85,9 @@ You can find an inventory of commands in the `makefile`. \*nix users can run the
A typical development workflow includes: A typical development workflow includes:
* Installing dependencies: `poetry install`
* Running tests: `make test` * Running tests: `make test`
* Running the source in a virtual environment: * Running the source in a virtual environment:
* `poetry install`
* `poetry shell` * `poetry shell`
* `jrnl` (with or without arguments as necessary) * `jrnl` (with or without arguments as necessary)
* Linting the code to standardize its style: `make lint` * Linting the code to standardize its style: `make lint`