You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+4-5Lines changed: 4 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -182,7 +182,7 @@ But it's way more comfortable to run it locally and *git* catching avoidable err
182
182
"""
183
183
```
184
184
- 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.
186
186
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.
187
187
If you don't, [CI] will catch it for you – but that seems like a waste of your time!
188
188
@@ -200,7 +200,7 @@ But it's way more comfortable to run it locally and *git* catching avoidable err
200
200
201
201
- To run the test suite, all you need is a recent [*tox*].
202
202
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`.
204
204
205
205
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.
206
206
- 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
210
210
211
211
## Documentation
212
212
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`):
214
214
215
215
```rst
216
216
This is a sentence.
@@ -278,7 +278,7 @@ or:
278
278
279
279
---
280
280
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.
282
282
283
283
284
284
## Governance
@@ -296,4 +296,3 @@ If you'd like to join, just get a pull request merged and ask to be added in the
0 commit comments