Skip to content

Commit

Permalink
Add section for contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
oliviagyg committed Nov 24, 2023
1 parent 59ad900 commit 6370975
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,4 +99,8 @@ More detailed examples are available [here](./examples).

## Contributing

(How to get started as a contributor, e.g. environment setup, Olivia will write this)
To contribute, you'll need a working python 3.8+ installation. We also recommend setting up a virtual environment for the project. You'll also need to [install poetry](https://python-poetry.org/docs/) if it's not already present.

Once you have the dependencies installed (with `poetry install`), you can set up pre-commit with `pre-commit install`. We run pre-commit in our CI as well, but it's recommended to install it locally so that you get immediate feedback from our various linters.

Beyond that, there's not really anything else you need to know to start contributing! Please create a pull request with whatever changes you'd like to propose and increment the version and update the changelog if necessary.

0 comments on commit 6370975

Please sign in to comment.