From ae309f3f2f5100d68036c47567ebd82f29d49305 Mon Sep 17 00:00:00 2001 From: Colin Dean Date: Mon, 4 Oct 2021 19:24:33 -0400 Subject: [PATCH 1/3] Adds a brief CONTRIBUTING onboarding document --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..5395a4fd2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# 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. From 9b4a69ff5c13c7021e3a7ce2e3f365e99f8a0719 Mon Sep 17 00:00:00 2001 From: Colin Dean Date: Mon, 4 Oct 2021 19:41:42 -0400 Subject: [PATCH 2/3] Adds CONTRIBUTING step about pre-commit --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5395a4fd2..f2d9b5371 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,3 +20,7 @@ 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 From fa015b288dd9a95c29e2d1f241e2a8a6f91a5020 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sun, 14 May 2023 20:42:55 +0000 Subject: [PATCH 3/3] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f2d9b5371..76f038511 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ 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. +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 -