Skip to content

Add policy for type checker bugs #16070

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

Open
srittau wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −0
Open

Add policy for type checker bugs #16070

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,3 +472,21 @@ To keep the number of open PRs manageable, we may close PRs when they have been
open for too long. Specifically, we close open PRs that either have failures in CI,
serious merge conflicts or unaddressed feedback, and that have not seen any
activity in three months.

## Type-checker bugs

In general we don't work around type checker bugs or missing features in
typeshed, with a few exceptions:

- To make typeshed CI pass (and an ignore statement won't work)
- If not working around the bug would negatively affect a significant
number of users
- If the workaround is more complicated, but equally correct, and will
positively affect a significant number of users

In all cases where a workaround is needed, add a comment to the workaround
with a link to the issue in the type checker's bug tracker, if possible.

We also track when we can start to use new typing features using the
[feature tracker label](https://github.com/python/typeshed/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22project%3A%20feature%20tracker%22)
for our GitHub issues.