Skip to content

Commit 12ef43c

Browse files
authored
Rename "Preparing Changes" to "Making Changes" (#13901)
And integrate the "Code Style" chapter there. This makes the actual chapter structure follow the overview structure.
1 parent 232c31c commit 12ef43c

1 file changed

Lines changed: 23 additions & 25 deletions

File tree

CONTRIBUTING.md

Lines changed: 23 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ are important to the project's success.
99

1010
1. [Prepare your environment](#preparing-the-environment).
1111
2. Find out [where to make your changes](#where-to-make-changes).
12-
3. [Prepare your changes](#preparing-changes):
12+
3. [Making your changes](#making-changes):
1313
* Small fixes and additions can be submitted directly as pull requests,
1414
but [contact us](README.md#discussion) before starting significant work.
1515
* Create your stubs, considering [what to include](#what-to-include) and
@@ -112,29 +112,6 @@ as it's currently excluded from the requirements file:
112112
</tr>
113113
</table>
114114

115-
## Code formatting
116-
117-
The code is formatted using [`Black`](https://github.com/psf/black).
118-
Various other autofixes and lint rules are
119-
also performed by [`Ruff`](https://github.com/astral-sh/ruff) and
120-
[`Flake8`](https://github.com/pycqa/flake8),
121-
with plugin [`flake8-pyi`](https://github.com/pycqa/flake8-pyi).
122-
123-
The repository is equipped with a [pre-commit.ci](https://pre-commit.ci/)
124-
configuration file. This means that you don't *need* to do anything yourself to
125-
run the code formatters or linters. When you push a commit, a bot will run
126-
those for you right away and add any autofixes to your PR. Anything
127-
that can't be autofixed will show up as a CI failure, hopefully with an error
128-
message that will make it clear what's gone wrong.
129-
130-
That being said, if you *want* to run the formatters and linters locally
131-
when you commit, you're free to do so. To use the same configuration as we use
132-
in CI, we recommend doing this via pre-commit:
133-
134-
```bash
135-
(.venv)$ pre-commit run --all-files
136-
```
137-
138115
## Where to make changes
139116

140117
### Standard library stubs
@@ -260,7 +237,7 @@ The format of all `METADATA.toml` files can be checked by running
260237
`python3 ./tests/check_typeshed_structure.py`.
261238

262239

263-
## Preparing Changes
240+
## Making Changes
264241

265242
### Before you begin
266243

@@ -275,6 +252,27 @@ Each Python module is represented by a .pyi "stub file". This is a syntactically
275252

276253
Typeshed follows the standard type system guidelines for [stub content](https://typing.readthedocs.io/en/latest/guides/writing_stubs.html#stub-content) and [coding style](https://typing.readthedocs.io/en/latest/guides/writing_stubs.html#style-guide).
277254

255+
The code is formatted using [`Black`](https://github.com/psf/black).
256+
Various other autofixes and lint rules are
257+
also performed by [`Ruff`](https://github.com/astral-sh/ruff) and
258+
[`Flake8`](https://github.com/pycqa/flake8),
259+
with plugin [`flake8-pyi`](https://github.com/pycqa/flake8-pyi).
260+
261+
The repository is equipped with a [pre-commit.ci](https://pre-commit.ci/)
262+
configuration file. This means that you don't *need* to do anything yourself to
263+
run the code formatters or linters. When you push a commit, a bot will run
264+
those for you right away and add any autofixes to your PR. Anything
265+
that can't be autofixed will show up as a CI failure, hopefully with an error
266+
message that will make it clear what's gone wrong.
267+
268+
That being said, if you *want* to run the formatters and linters locally
269+
when you commit, you're free to do so. To use the same configuration as we use
270+
in CI, we recommend doing this via pre-commit:
271+
272+
```bash
273+
(.venv)$ pre-commit run --all-files
274+
```
275+
278276
### What to include
279277

280278
Stubs should include the complete interface (classes, functions,

0 commit comments

Comments
 (0)