Skip to content

Commit

Permalink
add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cacrespo committed Feb 12, 2023
1 parent c33ac3e commit 38c22c4
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# How to contribute to the project

Thank you very much for you interest in the project! :smile:


First, choose a issue (or create one with suggestions, ideas, tips...) and wait for the assignment.

Then clone the repository and work on the development branch.

## Setup

We strongest suggest create a virtualenv, activate and install requirements.

$ python3 -m venv env
$ source env/bin/activate
(env) $ pip install -r requirements-dev.txt

## Run tests

Get into the virtualenv, and:

(env) $ python -m pytest tests/

0 comments on commit 38c22c4

Please sign in to comment.