Skip to content

Commit 84aaef5

Browse files
authored
CONTRIBUTING.md: more words for first-time contributors (#12193)
mypy attracts a lot of (usually student) first-time contributors who tend to comment on issues with things like "May I work on this issue? Can anyone provide me guidance?" and often end up not getting a response. The goal of this PR is to have a section we can just link to as a reply in such situations.
1 parent eef316d commit 84aaef5

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,12 @@ You can also use `tox` to run tests, for instance:
5454
tox -e py
5555
```
5656

57+
The easiest way to run a single test is:
58+
```
59+
pytest -n0 -k 'test_name'
60+
```
61+
There's more useful information on writing and running tests [here](test-data/unit/README.md)
62+
5763
## First time contributors
5864

5965
If you're looking for things to help with, browse our [issue tracker](https://github.com/python/mypy/issues)!
@@ -63,21 +69,24 @@ In particular, look for:
6369
- [good second issues](https://github.com/python/mypy/labels/good-second-issue)
6470
- [documentation issues](https://github.com/python/mypy/labels/documentation)
6571

66-
It's also extremely easy to get started contributing to our sister project
67-
[typeshed](https://github.com/python/typeshed/issues) that provides type stubs
68-
for libraries. This is a great way to become familiar with type syntax.
69-
70-
If you need help getting started, don't hesitate to ask on
71-
[gitter](https://gitter.im/python/typing).
72+
You do not need to ask for permission to work on any of these issues.
73+
Just fix the issue yourself, [try to add a unit test](#running-tests) and
74+
[open a pull request](#submitting-changes).
7275

7376
To get help fixing a specific issue, it's often best to comment on the issue
74-
itself. The more details you provide about what you've tried and where you've
75-
looked, the easier it will be for you to get help.
77+
itself. You're much more likely to get help if you provide details about what
78+
you've tried and where you've looked (maintainers tend to help those who help
79+
themselves). [gitter](https://gitter.im/python/typing) can also be a good place
80+
to ask for help.
7681

7782
Interactive debuggers like `pdb` and `ipdb` are really useful for getting
7883
started with the mypy codebase. This is a
7984
[useful tutorial](https://realpython.com/python-debugging-pdb/).
8085

86+
It's also extremely easy to get started contributing to our sister project
87+
[typeshed](https://github.com/python/typeshed/issues) that provides type stubs
88+
for libraries. This is a great way to become familiar with type syntax.
89+
8190
## Submitting changes
8291

8392
Even more excellent than a good bug report is a fix for a bug, or the

0 commit comments

Comments
 (0)