Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds a brief CONTRIBUTING onboarding document #217

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing

## Setup

1. Install and configured Python versions however is appropriate for your operating system
(try [`pyenv`](https://github.com/pyenv/pyenv)).
2. Ensure you are working with the latest release version of Poetry, to start.
Follow the instructions the installer outputs in order to ensure that `poetry` is on your `PATH`.

curl -sL https://raw.githubusercontent.com/python-poetry/poetry/master/install-poetry.py | python -

3. Install dependencies

poetry install

4. Run tests

poetry run tox

5. If all tests pass for all Python versions, you're in great shape!
If tests pass for just one and not the others because you've not installed that Python version, you're
probably OK, but keep an eye out for problems when you submit the PR.

6. Install the git pre-commit hooks with [`pre-commit`](https://pre-commit.com/):

pre-commit install --install-hooks