Provide guidelines for backporting
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.1k
- Forks
- 1k
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 12
Description
The devguide currently gives information about how to do a backport of a fix from the feature (master) branch to maintenance branches but I see very little in the way of guidance on how to decide if a backport is needed. The question has come up with core developers not really knowing what our policy, resulting in either a potentially beneficial fix not reaching users until one (even two) feature releases have passed or a fix being sent out prematurely in current maintenance releases introducing risk or, worse, an unnecessary incompatibility.
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 with the devguide's existing section on backporting fixes from the feature (master) branch to maintenance branches. Review the current guidance and document how developers should decide whether a backport is needed, including the risks of delaying or sending a fix prematurely; done means the policy is clear enough to guide those decisions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100