From 9768ef05939140171e66ebca9a27bc927df1ce2b Mon Sep 17 00:00:00 2001 From: Florent Jeannot <12172017+FlorentJeannot@users.noreply.github.com> Date: Tue, 27 Apr 2021 23:34:52 +0200 Subject: [PATCH 01/19] add tox in setup.cfg --- setup.cfg | 1 + 1 file changed, 1 insertion(+) diff --git a/setup.cfg b/setup.cfg index dc29b0f09..5b001578d 100644 --- a/setup.cfg +++ b/setup.cfg @@ -41,6 +41,7 @@ testing = pytest pytest-rerunfailures pytest-xdist + tox coverage = pytest-cov [options.entry_points] From d44763ef81ad8b66dfd2fd593cd8568f1f77ea85 Mon Sep 17 00:00:00 2001 From: Florent Jeannot <12172017+FlorentJeannot@users.noreply.github.com> Date: Thu, 29 Apr 2021 00:25:59 +0200 Subject: [PATCH 02/19] reverted changes in setup.cfg and improved CONTRIBUTING.md --- CONTRIBUTING.md | 18 ++++++++++++++++-- setup.cfg | 1 - 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9542aa23b..835a37b93 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,13 +4,27 @@ This is a [Jazzband](https://jazzband.co/) project. By contributing you agree to abide by the [Contributor Code of Conduct](https://jazzband.co/about/conduct) and follow the [guidelines](https://jazzband.co/about/guidelines). +## Getting started + +Install tox: + + pip install tox + +Create a virtual environment, with `pip-tools` in development mode and its test dependencies, +using your current python version: + + tox --devenv .venv -e py + +Activate the virtual env: + + source ./.venv/bin/activate + ## Project Contribution Guidelines Here are a few additional or emphasized guidelines to follow when contributing to pip-tools: -- Install pip-tools in development mode and its test dependencies with `pip install -e .[testing]`. - Check with `tox -e checkqa` to see your changes are not breaking the style conventions. -- Always provide tests for your changes. +- Always provide tests for your changes, use `tox -e coverage` to run the tests with coverage reports. - Give a clear one-line description in the PR (that the maintainers can add to [CHANGELOG](CHANGELOG.md) afterwards). - Wait for the review of at least one other contributor before merging (even if you're a Jazzband member). - Before merging, assign the PR to a milestone for a version to help with the release process. diff --git a/setup.cfg b/setup.cfg index 5b001578d..dc29b0f09 100644 --- a/setup.cfg +++ b/setup.cfg @@ -41,7 +41,6 @@ testing = pytest pytest-rerunfailures pytest-xdist - tox coverage = pytest-cov [options.entry_points] From 1c83b2849733d81098592ad61ca699319dc5ffdd Mon Sep 17 00:00:00 2001 From: Florent Jeannot <12172017+FlorentJeannot@users.noreply.github.com> Date: Thu, 29 Apr 2021 00:30:26 +0200 Subject: [PATCH 03/19] tweaked word in CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 835a37b93..513b39b5a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,7 +15,7 @@ using your current python version: tox --devenv .venv -e py -Activate the virtual env: +Activate the virtual environment: source ./.venv/bin/activate From 2ffc06dcd670857b07ceda99c45ec16d1d3dcfcd Mon Sep 17 00:00:00 2001 From: Florent Jeannot <12172017+FlorentJeannot@users.noreply.github.com> Date: Thu, 29 Apr 2021 00:58:41 +0200 Subject: [PATCH 04/19] Update CONTRIBUTING.md Co-authored-by: Sviatoslav Sydorenko --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 513b39b5a..58909733f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,7 +17,7 @@ using your current python version: Activate the virtual environment: - source ./.venv/bin/activate + source .venv/bin/activate ## Project Contribution Guidelines From ec10aec5ccfe08cd20d7d77d35c454ff9f0d6240 Mon Sep 17 00:00:00 2001 From: Florent Jeannot <12172017+FlorentJeannot@users.noreply.github.com> Date: Thu, 29 Apr 2021 01:00:35 +0200 Subject: [PATCH 05/19] Update CONTRIBUTING.md Co-authored-by: Sviatoslav Sydorenko --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 58909733f..b862609b7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,9 @@ and follow the [guidelines](https://jazzband.co/about/guidelines). Install tox: - pip install tox +```console +$ python -m pip install tox --user +```\ Create a virtual environment, with `pip-tools` in development mode and its test dependencies, using your current python version: From 13581efa714619f79ead800247732fff5a838c64 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 28 Apr 2021 23:00:55 +0000 Subject: [PATCH 06/19] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b862609b7..5c3aeba64 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ and follow the [guidelines](https://jazzband.co/about/guidelines). Install tox: -```console +````console $ python -m pip install tox --user ```\ @@ -65,3 +65,4 @@ To help keeping track of the releases and their changes, here's the current rele Please be mindful of other before and when performing a release, and use this access responsibly. Do not hesitate to ask questions if you have any before performing a release. +```` From cfaa7679b997e72d3f368405b7fc744b19d0f0b0 Mon Sep 17 00:00:00 2001 From: Florent Jeannot <12172017+FlorentJeannot@users.noreply.github.com> Date: Thu, 29 Apr 2021 01:46:46 +0200 Subject: [PATCH 07/19] tweaked markdown format in getting started --- CONTRIBUTING.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5c3aeba64..63a00ec06 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,18 +8,22 @@ and follow the [guidelines](https://jazzband.co/about/guidelines). Install tox: -````console +```console $ python -m pip install tox --user -```\ +``` Create a virtual environment, with `pip-tools` in development mode and its test dependencies, using your current python version: - tox --devenv .venv -e py +```console +$ tox --devenv .venv -e py +``` Activate the virtual environment: - source .venv/bin/activate +```console +$ source .venv/bin/activate +``` ## Project Contribution Guidelines From f491b6e76eee2e22a1083911b21830a504a894ac Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 28 Apr 2021 23:47:09 +0000 Subject: [PATCH 08/19] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 63a00ec06..b41a08bdd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -69,4 +69,7 @@ To help keeping track of the releases and their changes, here's the current rele Please be mindful of other before and when performing a release, and use this access responsibly. Do not hesitate to ask questions if you have any before performing a release. -```` + +``` + +``` From 42dc85c5679ed1aa9ab4f77ad01a812a259a6cbc Mon Sep 17 00:00:00 2001 From: Florent Jeannot <12172017+FlorentJeannot@users.noreply.github.com> Date: Thu, 29 Apr 2021 01:50:15 +0200 Subject: [PATCH 09/19] removed markdown added by pre-commit-ci bot --- CONTRIBUTING.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b41a08bdd..db01723ef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -68,8 +68,4 @@ To help keeping track of the releases and their changes, here's the current rele Please be mindful of other before and when performing a release, and use this access responsibly. -Do not hesitate to ask questions if you have any before performing a release. - -``` - -``` +Do not hesitate to ask questions if you have any before performing a release. \ No newline at end of file From 16e51180761f57b2a336ab56f68a29f1cb39eaea Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 28 Apr 2021 23:50:41 +0000 Subject: [PATCH 10/19] [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 db01723ef..be1785af8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -68,4 +68,4 @@ To help keeping track of the releases and their changes, here's the current rele Please be mindful of other before and when performing a release, and use this access responsibly. -Do not hesitate to ask questions if you have any before performing a release. \ No newline at end of file +Do not hesitate to ask questions if you have any before performing a release. From 5e9be2456a11f6ee543b785cf519d5c89d7ab863 Mon Sep 17 00:00:00 2001 From: Florent Jeannot <12172017+FlorentJeannot@users.noreply.github.com> Date: Sun, 2 May 2021 23:29:10 +0200 Subject: [PATCH 11/19] Moved "Getting Started" to "Development Guidelines" and added more guidelines. Tweaked "Project Contribution Guidelines". --- CONTRIBUTING.md | 85 ++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 66 insertions(+), 19 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index db01723ef..6b9046078 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,19 +4,30 @@ This is a [Jazzband](https://jazzband.co/) project. By contributing you agree to abide by the [Contributor Code of Conduct](https://jazzband.co/about/conduct) and follow the [guidelines](https://jazzband.co/about/guidelines). -## Getting started +## Project Contribution Guidelines -Install tox: +Here are a few additional or emphasized guidelines to follow when contributing to `pip-tools`: -```console -$ python -m pip install tox --user -``` +- Always provide tests for your changes. +- Give a clear one-line description in the PR (that the maintainers can add to [CHANGELOG](CHANGELOG.md) afterwards). +- Wait for the review of at least one other contributor before merging (even if you're a Jazzband member). +- Before merging, assign the PR to a milestone for a version to help with the release process. + +The only exception to those guidelines is for trivial changes, such as +documentation corrections or contributions that do not change pip-tools itself. + +Contributions following these guidelines are always welcomed, encouraged and appreciated. + +## Development Guidelines -Create a virtual environment, with `pip-tools` in development mode and its test dependencies, -using your current python version: +### Installation + +This project requires Python 3.6 or higher. + +At the project's root, create a virtual environment, using your current Python 3 version: ```console -$ tox --devenv .venv -e py +$ python3 -m venv .venv ``` Activate the virtual environment: @@ -25,20 +36,56 @@ Activate the virtual environment: $ source .venv/bin/activate ``` -## Project Contribution Guidelines +Install `pip-tools` in development mode and its test dependencies: -Here are a few additional or emphasized guidelines to follow when contributing to pip-tools: +```console +$ pip install -e .[testing] +``` -- Check with `tox -e checkqa` to see your changes are not breaking the style conventions. -- Always provide tests for your changes, use `tox -e coverage` to run the tests with coverage reports. -- Give a clear one-line description in the PR (that the maintainers can add to [CHANGELOG](CHANGELOG.md) afterwards). -- Wait for the review of at least one other contributor before merging (even if you're a Jazzband member). -- Before merging, assign the PR to a milestone for a version to help with the release process. +If you are using `zsh`, you need to escape the brackets: `\[testing\]`. -The only exception to those guidelines is for trivial changes, such as -documentation corrections or contributions that do not change pip-tools itself. -Contributions following these guidelines are always welcomed, encouraged and appreciated. +### Testing with pytest + +This project uses [pytest](https://docs.pytest.org/en/stable/contents.html) to run the tests. + +Inside your virtual environment, at the project's root, use: + +```console +$ pytest +``` + + +### Testing with tox + +This project uses [tox](https://tox.readthedocs.io/en/latest/) to test different environments. + +To install several Python versions, use [pyenv](https://github.com/pyenv/pyenv). +To help `tox` find out which Python versions are installed, at the root of the project, declare the versions using +`pyenv local ...`. For example: + +```console +$ pyenv local 3.7.10 3.8.9 3.9.4 +``` + +Inside your virtual environment, install `tox`: + +```console +$ pip install tox +``` + +Prepare `tox` to use the Python versions: + +```console +$ tox --notest -p auto --parallel-live +``` + +Run `tox` in parallel: + +```console +$ tox -p auto +``` + ## Project Release Process @@ -68,4 +115,4 @@ To help keeping track of the releases and their changes, here's the current rele Please be mindful of other before and when performing a release, and use this access responsibly. -Do not hesitate to ask questions if you have any before performing a release. \ No newline at end of file +Do not hesitate to ask questions if you have any before performing a release. From 146ca44ebb779156c1246f32672867563aa4cbc0 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Sun, 2 May 2021 21:29:55 +0000 Subject: [PATCH 12/19] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- CONTRIBUTING.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b9046078..3e6f5c0a3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,7 +44,6 @@ $ pip install -e .[testing] If you are using `zsh`, you need to escape the brackets: `\[testing\]`. - ### Testing with pytest This project uses [pytest](https://docs.pytest.org/en/stable/contents.html) to run the tests. @@ -55,14 +54,13 @@ Inside your virtual environment, at the project's root, use: $ pytest ``` - ### Testing with tox This project uses [tox](https://tox.readthedocs.io/en/latest/) to test different environments. To install several Python versions, use [pyenv](https://github.com/pyenv/pyenv). To help `tox` find out which Python versions are installed, at the root of the project, declare the versions using -`pyenv local ...`. For example: +`pyenv local ...`. For example: ```console $ pyenv local 3.7.10 3.8.9 3.9.4 @@ -86,7 +84,6 @@ Run `tox` in parallel: $ tox -p auto ``` - ## Project Release Process Jazzband aims to give full access to all members, including performing releases, as described in the From 76f3cc8d1cee6252bddc0a85933a011374b12dad Mon Sep 17 00:00:00 2001 From: Florent Jeannot <12172017+FlorentJeannot@users.noreply.github.com> Date: Mon, 3 May 2021 00:47:25 +0200 Subject: [PATCH 13/19] revert guideline, suggest websites to get started --- CONTRIBUTING.md | 74 +++---------------------------------------------- 1 file changed, 4 insertions(+), 70 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b9046078..a01eadf4f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,10 @@ and follow the [guidelines](https://jazzband.co/about/guidelines). Here are a few additional or emphasized guidelines to follow when contributing to `pip-tools`: -- Always provide tests for your changes. +- To set up your project's environment, have a look at [Python Packaging User Guide](https://packaging.python.org) + and [Real Python Tutorials](https://realpython.com) +- Install pip-tools in development mode and its test dependencies with `pip install -e '.[testing]'`. +- Check with `tox -e checkqa` to see your changes are not breaking the style conventions. - Give a clear one-line description in the PR (that the maintainers can add to [CHANGELOG](CHANGELOG.md) afterwards). - Wait for the review of at least one other contributor before merging (even if you're a Jazzband member). - Before merging, assign the PR to a milestone for a version to help with the release process. @@ -18,75 +21,6 @@ documentation corrections or contributions that do not change pip-tools itself. Contributions following these guidelines are always welcomed, encouraged and appreciated. -## Development Guidelines - -### Installation - -This project requires Python 3.6 or higher. - -At the project's root, create a virtual environment, using your current Python 3 version: - -```console -$ python3 -m venv .venv -``` - -Activate the virtual environment: - -```console -$ source .venv/bin/activate -``` - -Install `pip-tools` in development mode and its test dependencies: - -```console -$ pip install -e .[testing] -``` - -If you are using `zsh`, you need to escape the brackets: `\[testing\]`. - - -### Testing with pytest - -This project uses [pytest](https://docs.pytest.org/en/stable/contents.html) to run the tests. - -Inside your virtual environment, at the project's root, use: - -```console -$ pytest -``` - - -### Testing with tox - -This project uses [tox](https://tox.readthedocs.io/en/latest/) to test different environments. - -To install several Python versions, use [pyenv](https://github.com/pyenv/pyenv). -To help `tox` find out which Python versions are installed, at the root of the project, declare the versions using -`pyenv local ...`. For example: - -```console -$ pyenv local 3.7.10 3.8.9 3.9.4 -``` - -Inside your virtual environment, install `tox`: - -```console -$ pip install tox -``` - -Prepare `tox` to use the Python versions: - -```console -$ tox --notest -p auto --parallel-live -``` - -Run `tox` in parallel: - -```console -$ tox -p auto -``` - - ## Project Release Process Jazzband aims to give full access to all members, including performing releases, as described in the From dde55b996eeb3bf9bd04051029429e23523a4af1 Mon Sep 17 00:00:00 2001 From: Florent Jeannot <12172017+FlorentJeannot@users.noreply.github.com> Date: Mon, 3 May 2021 00:50:20 +0200 Subject: [PATCH 14/19] add missing line in guideline --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a01eadf4f..eb77c0012 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,6 +12,7 @@ Here are a few additional or emphasized guidelines to follow when contributing t and [Real Python Tutorials](https://realpython.com) - Install pip-tools in development mode and its test dependencies with `pip install -e '.[testing]'`. - Check with `tox -e checkqa` to see your changes are not breaking the style conventions. +- Always provide tests for your changes. - Give a clear one-line description in the PR (that the maintainers can add to [CHANGELOG](CHANGELOG.md) afterwards). - Wait for the review of at least one other contributor before merging (even if you're a Jazzband member). - Before merging, assign the PR to a milestone for a version to help with the release process. From 1ce92b4ab2c89b52545039d1ad8fbd7cd047edeb Mon Sep 17 00:00:00 2001 From: Florent Jeannot <12172017+FlorentJeannot@users.noreply.github.com> Date: Mon, 3 May 2021 21:04:51 +0200 Subject: [PATCH 15/19] tweak guideline to make the flow tox-centric --- CONTRIBUTING.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eb77c0012..bbda16f7a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,11 +8,8 @@ and follow the [guidelines](https://jazzband.co/about/guidelines). Here are a few additional or emphasized guidelines to follow when contributing to `pip-tools`: -- To set up your project's environment, have a look at [Python Packaging User Guide](https://packaging.python.org) - and [Real Python Tutorials](https://realpython.com) -- Install pip-tools in development mode and its test dependencies with `pip install -e '.[testing]'`. -- Check with `tox -e checkqa` to see your changes are not breaking the style conventions. -- Always provide tests for your changes. +- Use `tox` to create a [development environment](https://tox.readthedocs.io/en/latest/example/devenv.html#creating-development-environments-using-the-devenv-option) +- Always provide tests for your changes and run `tox -p all` to make sure your changes are passing the checks. - Give a clear one-line description in the PR (that the maintainers can add to [CHANGELOG](CHANGELOG.md) afterwards). - Wait for the review of at least one other contributor before merging (even if you're a Jazzband member). - Before merging, assign the PR to a milestone for a version to help with the release process. From 1ce0e8c4cc0341978e868246ef826aa7558900bc Mon Sep 17 00:00:00 2001 From: Florent Jeannot <12172017+FlorentJeannot@users.noreply.github.com> Date: Mon, 3 May 2021 21:06:41 +0200 Subject: [PATCH 16/19] tweak sentence --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bbda16f7a..fbe2a5656 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ and follow the [guidelines](https://jazzband.co/about/guidelines). Here are a few additional or emphasized guidelines to follow when contributing to `pip-tools`: - Use `tox` to create a [development environment](https://tox.readthedocs.io/en/latest/example/devenv.html#creating-development-environments-using-the-devenv-option) -- Always provide tests for your changes and run `tox -p all` to make sure your changes are passing the checks. +- Always provide tests for your changes and run `tox -p all` to make sure they are passing the checks. - Give a clear one-line description in the PR (that the maintainers can add to [CHANGELOG](CHANGELOG.md) afterwards). - Wait for the review of at least one other contributor before merging (even if you're a Jazzband member). - Before merging, assign the PR to a milestone for a version to help with the release process. From 1b549fb98252674b878f7f924027d59272ce35ce Mon Sep 17 00:00:00 2001 From: Florent Jeannot <12172017+FlorentJeannot@users.noreply.github.com> Date: Mon, 3 May 2021 21:07:13 +0200 Subject: [PATCH 17/19] add missing dot --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fbe2a5656..6d87eb7b0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ and follow the [guidelines](https://jazzband.co/about/guidelines). Here are a few additional or emphasized guidelines to follow when contributing to `pip-tools`: -- Use `tox` to create a [development environment](https://tox.readthedocs.io/en/latest/example/devenv.html#creating-development-environments-using-the-devenv-option) +- Use `tox` to create a [development environment](https://tox.readthedocs.io/en/latest/example/devenv.html#creating-development-environments-using-the-devenv-option). - Always provide tests for your changes and run `tox -p all` to make sure they are passing the checks. - Give a clear one-line description in the PR (that the maintainers can add to [CHANGELOG](CHANGELOG.md) afterwards). - Wait for the review of at least one other contributor before merging (even if you're a Jazzband member). From 108cb542fd8c91e1d4833f4cd72df2d890b0c492 Mon Sep 17 00:00:00 2001 From: Florent Jeannot <12172017+FlorentJeannot@users.noreply.github.com> Date: Wed, 5 May 2021 21:22:42 +0200 Subject: [PATCH 18/19] Update CONTRIBUTING.md Co-authored-by: Sviatoslav Sydorenko --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6d87eb7b0..848ad36ef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,7 @@ and follow the [guidelines](https://jazzband.co/about/guidelines). Here are a few additional or emphasized guidelines to follow when contributing to `pip-tools`: -- Use `tox` to create a [development environment](https://tox.readthedocs.io/en/latest/example/devenv.html#creating-development-environments-using-the-devenv-option). +- If you need to have a virtualenv outside of `tox`, it is possible to reuse its configuration to provision it as [described in the docs](https://tox.readthedocs.io/en/latest/example/devenv.html#creating-development-environments-using-the-devenv-option). - Always provide tests for your changes and run `tox -p all` to make sure they are passing the checks. - Give a clear one-line description in the PR (that the maintainers can add to [CHANGELOG](CHANGELOG.md) afterwards). - Wait for the review of at least one other contributor before merging (even if you're a Jazzband member). From e50a524a42e1c0004b91d7e0ca66299df7c1540d Mon Sep 17 00:00:00 2001 From: Florent Jeannot <12172017+FlorentJeannot@users.noreply.github.com> Date: Wed, 5 May 2021 21:23:03 +0200 Subject: [PATCH 19/19] Update CONTRIBUTING.md Co-authored-by: Sviatoslav Sydorenko --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 848ad36ef..f7ea4c149 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ and follow the [guidelines](https://jazzband.co/about/guidelines). Here are a few additional or emphasized guidelines to follow when contributing to `pip-tools`: - If you need to have a virtualenv outside of `tox`, it is possible to reuse its configuration to provision it as [described in the docs](https://tox.readthedocs.io/en/latest/example/devenv.html#creating-development-environments-using-the-devenv-option). -- Always provide tests for your changes and run `tox -p all` to make sure they are passing the checks. +- Always provide tests for your changes and run `tox -p all` to make sure they are passing the checks locally. - Give a clear one-line description in the PR (that the maintainers can add to [CHANGELOG](CHANGELOG.md) afterwards). - Wait for the review of at least one other contributor before merging (even if you're a Jazzband member). - Before merging, assign the PR to a milestone for a version to help with the release process.