VimPlug/typeshed
1
0
Fork 0
mirror of https://github.com/davidhalter/typeshed.git synced 2026-06-24 09:48:39 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update third-party library removal policy (#14636)

Browse Source
This commit is contained in:
Semyon Moroz
2025-10-08 15:51:14 +04:00
committed by GitHub
parent b4dc047307
commit c6b6bb7a0b
1 changed files with 9 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+9 -13
View File
@@ -436,28 +436,24 @@ following criteria is met:
* the upstream package was declared or appears to be unmaintained, and
retaining the stubs causes maintenance issues in typeshed.
If a package ships its own `py.typed` file, please follow these steps:
Case 1: If a package ships its own `py.typed` file, please follow these steps:
1. Open an issue with the earliest month of removal in the subject.
2. A maintainer will add the
["stubs: removal" label](https://github.com/python/typeshed/labels/%22stubs%3A%20removal%22).
3. Open a PR that sets the `obsolete_since` field in the `METADATA.toml`
file to the first version of the package that shipped `py.typed`.
4. After at least six months, open a PR to remove the stubs.
1. Make sure **stubsabot** open a PR that sets the `obsolete_since` field in the
`METADATA.toml` file to the first version of the package that shipped `py.typed`.
2. After at least six months, make sure **stubsabot** open a PR to remove the stubs.
If third-party stubs should be removed for other reasons, please follow these
steps:
Case 2: If third-party stubs should be removed for other reasons, please follow
these steps:
1. Open an issue explaining why the stubs should be removed.
2. A maintainer will add the
["stubs: removal" label](https://github.com/python/typeshed/labels/%22stubs%3A%20removal%22).
3. Open a PR that sets the `no_longer_updated` field in the `METADATA.toml`
file to `true`.
4. When a new version of the package was automatically uploaded to PyPI
(which can take up to a day), open a PR to remove the stubs.
4. When a new version of the package was automatically uploaded to PyPI (which
can take up to a day), make sure **stubsabot** open a PR to remove the stubs.
Don't forget to make sure the library is not in the [`pyrightconfig.stricter.json`](./pyrightconfig.stricter.json)
exclusion list. If feeling kindly, please update [mypy](https://github.com/python/mypy/blob/master/mypy/stubinfo.py)
If feeling kindly, please update [mypy](https://github.com/python/mypy/blob/master/mypy/stubinfo.py)
for any stub obsoletions or removals.
### Marking PRs as "deferred"