Skip to content

Commit c365b3e

Browse files
committed
update contributing
1 parent c2ff96f commit c365b3e

1 file changed

Lines changed: 4 additions & 5 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ But it's way more comfortable to run it locally and *git* catching avoidable err
182182
"""
183183
```
184184
- If you add or change public APIs, tag the docstring using `.. versionadded:: 16.0.0 WHAT` or `.. versionchanged:: 16.2.0 WHAT`.
185-
- We use [*isort*](https://github.com/PyCQA/isort) to sort our imports, and we use [*Black*](https://github.com/psf/black) with line length of 79 characters to format our code.
185+
- We use [Ruff](https://github.com/astral-sh/ruff) to sort our imports, and we use [Black](https://github.com/psf/black) with line length of 79 characters to format our code.
186186
As long as you run our full [*tox*] suite before committing, or install our [*pre-commit*] hooks (ideally you'll do both – see [*Local Development Environment*](#local-development-environment) above), you won't have to spend any time on formatting your code at all.
187187
If you don't, [CI] will catch it for you – but that seems like a waste of your time!
188188

@@ -200,7 +200,7 @@ But it's way more comfortable to run it locally and *git* catching avoidable err
200200

201201
- To run the test suite, all you need is a recent [*tox*].
202202
It will ensure the test suite runs with all dependencies against all Python versions just as it will in our [CI].
203-
If you lack some Python versions, you can can always limit the environments like `tox -e py38,py39`, or make it a non-failure using `tox --skip-missing-interpreters`.
203+
If you lack some Python versions, you can can always limit the environments like `tox run -e py38,py39`, or make it a non-failure using `tox run --skip-missing-interpreters`.
204204

205205
In that case you should look into [*asdf*](https://asdf-vm.com) or [*pyenv*](https://github.com/pyenv/pyenv), which make it very easy to install many different Python versions in parallel.
206206
- Write [good test docstrings](https://jml.io/pages/test-docstrings.html).
@@ -210,7 +210,7 @@ But it's way more comfortable to run it locally and *git* catching avoidable err
210210

211211
## Documentation
212212

213-
- Use [semantic newlines] in [*reStructuredText*] and [*Markdown*](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) files (files ending in `.rst` and `.md`):
213+
- Use [semantic newlines] in [reStructuredText](https://www.sphinx-doc.org/en/stable/usage/restructuredtext/basics.html) and [Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) files (files ending in `.rst` and `.md`):
214214

215215
```rst
216216
This is a sentence.
@@ -278,7 +278,7 @@ or:
278278

279279
---
280280

281-
``tox -e changelog`` will render the current changelog to the terminal if you have any doubts.
281+
`tox run -e changelog` will render the current changelog to the terminal if you have any doubts.
282282

283283

284284
## Governance
@@ -296,4 +296,3 @@ If you'd like to join, just get a pull request merged and ask to be added in the
296296
[*pre-commit*]: https://pre-commit.com/
297297
[*tox*]: https://tox.wiki/
298298
[semantic newlines]: https://rhodesmill.org/brandon/2012/one-sentence-per-line/
299-
[*reStructuredText*]: https://www.sphinx-doc.org/en/stable/usage/restructuredtext/basics.html

0 commit comments

Comments
 (0)