From 84aaef5caea0bd0fdb0e9d0ac5c1e850611b22fd Mon Sep 17 00:00:00 2001 From: Shantanu <12621235+hauntsaninja@users.noreply.github.com> Date: Wed, 16 Feb 2022 15:43:00 -0800 Subject: [PATCH] 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. --- CONTRIBUTING.md | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9e5bdeb90a69c..eafefe346d01b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -54,6 +54,12 @@ You can also use `tox` to run tests, for instance: tox -e py ``` +The easiest way to run a single test is: +``` +pytest -n0 -k 'test_name' +``` +There's more useful information on writing and running tests [here](test-data/unit/README.md) + ## First time contributors 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: - [good second issues](https://github.com/python/mypy/labels/good-second-issue) - [documentation issues](https://github.com/python/mypy/labels/documentation) -It's also extremely easy to get started contributing to our sister project -[typeshed](https://github.com/python/typeshed/issues) that provides type stubs -for libraries. This is a great way to become familiar with type syntax. - -If you need help getting started, don't hesitate to ask on -[gitter](https://gitter.im/python/typing). +You do not need to ask for permission to work on any of these issues. +Just fix the issue yourself, [try to add a unit test](#running-tests) and +[open a pull request](#submitting-changes). To get help fixing a specific issue, it's often best to comment on the issue -itself. The more details you provide about what you've tried and where you've -looked, the easier it will be for you to get help. +itself. You're much more likely to get help if you provide details about what +you've tried and where you've looked (maintainers tend to help those who help +themselves). [gitter](https://gitter.im/python/typing) can also be a good place +to ask for help. Interactive debuggers like `pdb` and `ipdb` are really useful for getting started with the mypy codebase. This is a [useful tutorial](https://realpython.com/python-debugging-pdb/). +It's also extremely easy to get started contributing to our sister project +[typeshed](https://github.com/python/typeshed/issues) that provides type stubs +for libraries. This is a great way to become familiar with type syntax. + ## Submitting changes Even more excellent than a good bug report is a fix for a bug, or the