Skip to content

Commit e26df05

Browse files
authored
📝 CONTRIBUTING.md fixes (#760)
1 parent 9c526f9 commit e26df05

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,28 +27,28 @@ installed. Now you can install the project with the dev dependencies:
2727
uv sync --python 3.11
2828
```
2929

30-
By installing the lowest support Python version (3.11 in this example), it prevents
30+
Installing the lowest supported Python version (3.11 in this example) prevents
3131
your IDE from e.g. auto-importing unsupported `typing` features.
3232

3333
## Lefthook
3434

35-
[Lefthook] is a modern Git hooks manager, which automatically lints and formats
36-
your code before you committing it. It will also keep your `uv` environment
37-
up-to-date with the lockfile when you `git pull`.
35+
[Lefthook](https://github.com/evilmartians/lefthook) is a modern Git hooks manager,
36+
which automatically lints and formats your code before you commit it. It will also sync
37+
your `uv` environment with the lockfile when you `git pull` or `git checkout`.
3838

3939
To install it as a `uv` tool, run
4040

4141
```shell
4242
uv tool install lefthook --upgrade
4343
```
4444

45-
To set it up, navigate to the root of the `numtype` repo, and run
45+
To set it up, navigate to the root of the `scipy-stubs` repo, and run
4646

4747
```shell
4848
uvx lefthook install
4949
```
5050

51-
Now let's see it all works:
51+
Now let's see if it all works:
5252

5353
```bash
5454
$ uvx lefthook validate
@@ -96,7 +96,11 @@ mypy: OK ✔ in 16.69 seconds
9696

9797
All [documentation] lives in the `README.md`. Please read it carefully before proposing
9898
any changes. Ensure that the markdown is formatted correctly with
99-
[markdownlint](https://github.com/DavidAnson/markdownlint).
99+
[dprint][dprint] by running:
100+
101+
```shell
102+
uv run dprint fmt
103+
```
100104

101105
## Testing
102106

@@ -108,10 +112,11 @@ See <https://typing.python.org/en/latest/guides/writing_stubs.html#style-guide>.
108112

109113
## Commit message style
110114

111-
Scipy-stubs recommends using [Gitmoji](https://gitmoji.dev/) for commit messages and PR
112-
titles. For VSCode and VSCodium users, it is recommended to use the
113-
[`gitmoji-vscode` extension](https://github.com/seatonjiang/gitmoji-vscode) for this.
115+
scipy-stubs recommends using [Gitmoji](https://gitmoji.dev/) for commit messages and PR
116+
titles. For VSCode and VSCodium users, it can be convenient to use the
117+
[`gitmoji-vscode`](https://github.com/seatonjiang/gitmoji-vscode) extension for this.
114118

115119
[coc]: https://docs.scipy.org/doc/scipy/dev/conduct/code_of_conduct.html
116120
[license]: https://github.com/scipy/scipy-stubs/blob/master/LICENSE
117121
[tests]: https://github.com/scipy/scipy-stubs/tree/master/tests
122+
[dprint]: https://github.com/dprint/dprint

0 commit comments

Comments
 (0)