From 48acd0f21eb0ddaa6b78ac80bf6dac9d84019c31 Mon Sep 17 00:00:00 2001 From: juhoautio Date: Sat, 28 May 2022 00:37:57 +0300 Subject: [PATCH 1/6] docs: contributing doc: paste-able commands --- CONTRIBUTING.md | 14 +++++++------- docs/contributing.md | 14 +++++++------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 099130ea16d..3632268f93f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -107,8 +107,8 @@ You will need Poetry to start contributing on the Poetry codebase. Refer to the You will first need to clone the repository using `git` and place yourself in its directory: ```bash -$ git clone git@github.com:python-poetry/poetry.git -$ cd poetry +git clone git@github.com:python-poetry/poetry.git +cd poetry ``` > **Note:** We recommend that you use a personal [fork](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/fork-a-repo) for this step. If you are new to GitHub collaboration, @@ -118,15 +118,15 @@ Now, you will need to install the required dependency for Poetry and be sure tha tests are passing on your machine: ```bash -$ poetry install -$ poetry run pytest tests/ +poetry install +poetry run pytest tests/ ``` Poetry uses [mypy](https://github.com/python/mypy) for typechecking, and the CI will fail if it finds any errors. To run mypy locally: ```bash -$ poetry run mypy +poetry run mypy ``` Poetry uses the [black](https://github.com/psf/black) coding style and you must ensure that your @@ -139,13 +139,13 @@ To make sure that you don't accidentally commit code that does not follow the co install a pre-commit hook that will check that everything is in order: ```bash -$ poetry run pre-commit install +poetry run pre-commit install ``` You can also run it anytime using: ```bash -$ poetry run pre-commit run --all-files +poetry run pre-commit run --all-files ``` Your code must always be accompanied by corresponding tests, if tests are not present your code diff --git a/docs/contributing.md b/docs/contributing.md index cc034dd5b81..3708113807e 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -122,8 +122,8 @@ You will need Poetry to start contributing on the Poetry codebase. Refer to the You will first need to clone the repository using `git` and place yourself in its directory: ```bash -$ git clone git@github.com:python-poetry/poetry.git -$ cd poetry +git clone git@github.com:python-poetry/poetry.git +cd poetry ``` {{% note %}} @@ -135,15 +135,15 @@ Now, you will need to install the required dependency for Poetry and be sure tha tests are passing on your machine: ```bash -$ poetry install -$ poetry run pytest tests/ +poetry install +poetry run pytest tests/ ``` Poetry uses [mypy](https://github.com/python/mypy) for typechecking, and the CI will fail if it finds any errors. To run mypy locally: ```bash -$ poetry run mypy +poetry run mypy ``` Poetry uses the [black](https://github.com/psf/black) coding style and you must ensure that your @@ -156,13 +156,13 @@ To make sure that you don't accidentally commit code that does not follow the co install a pre-commit hook that will check that everything is in order: ```bash -$ poetry run pre-commit install +poetry run pre-commit install ``` You can also run it anytime using: ```bash -$ poetry run pre-commit run --all-files +poetry run pre-commit run --all-files ``` Your code must always be accompanied by corresponding tests, if tests are not present your code From e654257265f9fce3829e0e12a79b5bcd8f29e525 Mon Sep 17 00:00:00 2001 From: juhoautio Date: Tue, 31 May 2022 00:21:34 +0300 Subject: [PATCH 2/6] Comment about keeping docs in sync manually --- CONTRIBUTING.md | 2 ++ docs/contributing.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3632268f93f..fa0f5887ca3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,5 @@ + + # Contributing to Poetry First off, thanks for taking the time to contribute! diff --git a/docs/contributing.md b/docs/contributing.md index 3708113807e..9ea995e4a98 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,3 +1,5 @@ + + --- title: "Contributing to Poetry" draft: false From 9cbbc07d2bd78b88f84e16ef1e63e03499d64781 Mon Sep 17 00:00:00 2001 From: juhoautio Date: Tue, 31 May 2022 00:30:32 +0300 Subject: [PATCH 3/6] Local dev requires Python 3.8+ --- CONTRIBUTING.md | 2 ++ docs/contributing.md | 4 ++++ 2 files changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fa0f5887ca3..c292b45ffed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -106,6 +106,8 @@ the code base, join us on our [Discord Server](https://discordapp.com/invite/awx You will need Poetry to start contributing on the Poetry codebase. Refer to the [documentation](https://python-poetry.org/docs/#introduction) to start using Poetry. +> **Note:** Local development of poetry requires Python 3.8 or newer. + You will first need to clone the repository using `git` and place yourself in its directory: ```bash diff --git a/docs/contributing.md b/docs/contributing.md index 9ea995e4a98..91708317790 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -121,6 +121,10 @@ the code base, join us on our [Discord Server](https://discordapp.com/invite/awx You will need Poetry to start contributing on the Poetry codebase. Refer to the [documentation](https://python-poetry.org/docs/#introduction) to start using Poetry. +{{% note %}} +Local development of poetry requires Python 3.8 or newer. +{{% /note %}} + You will first need to clone the repository using `git` and place yourself in its directory: ```bash From 0a28e7515cc4f583b4151c7f83e7d2b50daea9d2 Mon Sep 17 00:00:00 2001 From: juhoautio Date: Tue, 31 May 2022 00:34:06 +0300 Subject: [PATCH 4/6] =?UTF-8?q?Split=20html=20comments=20to=20lines=20?= =?UTF-8?q?=E2=80=93=20does=20this=20fix=20hugo=20build=3F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 4 +++- docs/contributing.md | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c292b45ffed..693f13e6045 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,6 @@ - + # Contributing to Poetry diff --git a/docs/contributing.md b/docs/contributing.md index 91708317790..7f4295a1554 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,4 +1,6 @@ - + --- title: "Contributing to Poetry" From 2f617c2ee8b14ccfc4f0243175920b33cacb0982 Mon Sep 17 00:00:00 2001 From: juhoautio Date: Tue, 31 May 2022 00:40:48 +0300 Subject: [PATCH 5/6] Try to bring back contributing page as it disappeared :) --- docs/contributing.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index 7f4295a1554..e91a1d97d72 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,7 +1,3 @@ - - --- title: "Contributing to Poetry" draft: false @@ -13,6 +9,10 @@ menu: weight: 100 --- + + # Contributing to Poetry First off, thanks for taking the time to contribute! From be182a4aa15df9dc85c51c992585e2b8ea0afc94 Mon Sep 17 00:00:00 2001 From: juhoautio Date: Tue, 31 May 2022 00:44:37 +0300 Subject: [PATCH 6/6] Capitalize: "Poetry" --- CONTRIBUTING.md | 2 +- docs/contributing.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 693f13e6045..80a4b1ccb0e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -108,7 +108,7 @@ the code base, join us on our [Discord Server](https://discordapp.com/invite/awx You will need Poetry to start contributing on the Poetry codebase. Refer to the [documentation](https://python-poetry.org/docs/#introduction) to start using Poetry. -> **Note:** Local development of poetry requires Python 3.8 or newer. +> **Note:** Local development of Poetry requires Python 3.8 or newer. You will first need to clone the repository using `git` and place yourself in its directory: diff --git a/docs/contributing.md b/docs/contributing.md index e91a1d97d72..a8f80e773eb 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -124,7 +124,7 @@ the code base, join us on our [Discord Server](https://discordapp.com/invite/awx You will need Poetry to start contributing on the Poetry codebase. Refer to the [documentation](https://python-poetry.org/docs/#introduction) to start using Poetry. {{% note %}} -Local development of poetry requires Python 3.8 or newer. +Local development of Poetry requires Python 3.8 or newer. {{% /note %}} You will first need to clone the repository using `git` and place yourself in its directory: