Skip to content

docs: Improve contributing docs #5708

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.

Sign up for GitHub

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

Merged
neersighted merged 6 commits into from
Jun 4, 2022
Merged

docs: Improve contributing docs #5708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
48acd0f
docs: contributing doc: paste-able commands
juhoautio May 27, 2022
e654257
Comment about keeping docs in sync manually
juhoautio May 30, 2022
9cbbc07
Local dev requires Python 3.8+
juhoautio May 30, 2022
0a28e75
Split html comments to lines – does this fix hugo build?
juhoautio May 30, 2022
2f617c2
Try to bring back contributing page as it disappeared :)
juhoautio May 30, 2022
be182a4
Capitalize: "Poetry"
juhoautio May 30, 2022
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
20 changes: 13 additions & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--
The content of this file is manually kept in sync with docs/contributing.md. There are formatting differences because this file uses plain markdown.
-->

# Contributing to Poetry

First off, thanks for taking the time to contribute!
Expand Down Expand Up @@ -104,11 +108,13 @@ 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
$ 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,
Expand All @@ -118,15 +124,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
Expand All @@ -139,13 +145,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
Expand Down
22 changes: 15 additions & 7 deletions docs/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ menu:
weight: 100
---

<!--
The content of this file is manually kept in sync with ../CONTRIBUTING.md. There are formatting differences because this file uses Hugo templating.
-->

# Contributing to Poetry

First off, thanks for taking the time to contribute!
Expand Down Expand Up @@ -119,11 +123,15 @@ 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
$ git clone git@github.com:python-poetry/poetry.git
$ cd poetry
git clone git@github.com:python-poetry/poetry.git
cd poetry
```

{{% note %}}
Expand All @@ -135,15 +143,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
Expand All @@ -156,13 +164,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
Expand Down