From a34e5a36a8e45d1298f0aeab071342fc14339adc Mon Sep 17 00:00:00 2001 From: Sebastian Rittau Date: Thu, 13 May 2021 15:08:55 +0200 Subject: [PATCH] Describe third-party removal process (#5435) --- CONTRIBUTING.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8afdfa6c4..85abe5226 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -503,10 +503,18 @@ if it consisted of several smaller commits. Third-party packages are generally removed from typeshed when one of the following criteria is met: -* The upstream package ships a py.typed file for at least 6-12 months, or +* The upstream package ships a `py.typed` file for at least 6-12 months, or * the package does not support any of the Python versions supported by typeshed. +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 + ["removal" label](https://github.com/python/typeshed/labels/removal). +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`. + ## Maintainer guidelines The process for preparing and submitting changes also applies to