Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't accept new third party stubs anymore #2441

Closed
wants to merge 2 commits into from
Closed

Don't accept new third party stubs anymore #2441

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
12d1353
Don't accept new third party stubs anymore
srittau Sep 11, 2018
7642a0c
Clarify reviews
srittau Sep 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,10 @@ are important to the project's success.
2. Set up your environment to be able to [run all tests](README.md#running-the-tests). They should pass.
3. [Prepare your changes](#preparing-changes):
* [Contact us](#discussion) before starting significant work.
* IMPORTANT: For new libraries, [get permission from the library owner first](#adding-a-new-library).
* Create your stubs [conforming to the coding style](#stub-file-coding-style).
* Make sure your tests pass cleanly on `mypy`, `pytype`, and `flake8`.
4. [Submit your changes](#submitting-changes):
* Open a pull request
* For new libraries, [include a reference to where you got permission](#adding-a-new-library)
5. You can expect a reply within a few days:
* Diffs are merged when considered ready by the core team.
* Feel free to ping the core team if your pull request goes without
Expand Down Expand Up @@ -105,17 +103,22 @@ with what you'd like to do or have ideas that will help you do it.

### Adding a new library

If you want to submit type stubs for a new library, you need to
Stubs for new third party libraries are generally not accepted into
typeshed anymore. Such stubs should either be added directly to the
third party package or distributed as a separate package. See
[PEP 561](https://www.python.org/dev/peps/pep-0561/) for details.

When creating a separate package, you should
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we can't really control what happens outside of typeshed, I have softened the "need to" from the original text to a "should" here.

**contact the maintainers of the original library** first to let them
know and **get their permission**. Do it by opening an issue on their
project's bug tracker. This gives them the opportunity to
consider adopting type hints directly in their codebase (which you
should prefer to external type stubs). When the project owners agree
for you to submit stubs here, open a pull request **referencing the
message where you received permission**.
should prefer to external type stubs).

Make sure your changes pass the tests (the [README](README.md#running-the-tests)
has more information).
If you wish typeshed maintainers to review your third party stubs,
please [open a new issue](https://github.com/python/typeshed/issues/new)
in the typeshed repository with a link to the code you would like us to
review. Please note that reviews are provided as time allows.

### What to include

Expand Down