python-trio / python-trio/trio
Define and document our deprecation policy
Open
Nobody has claimed this yet.
project meta
- Dominant language
- Python
- Stars
- 7.3k
- Forks
- 431
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 6
Description
We've just had some discussion of this here on a closed PR; should probably promote it to a real issue :-)
https://github.com/python-trio/trio/pull/499
To do:
- Decide what our deprecation policy is for now. A reasonable start: deprecated code can be removed as soon as the deprecation warning has been in a release for 1 month
- Document this. I guess in contributing.rst and in issue #1?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the discussion in closed PR #499, then inspect contributing.rst and issue #1 as the proposed documentation locations. Agree on the deprecation policy, including the suggested one-month release period, and document the final decision in the relevant places.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100