Add toggle_removal_ticket annotation
Open
@Yagnesh1998 is already working on this.
Since Dec 20, 2023.
help wanted
- Dominant language
- Python
- Stars
- 6
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
Add annotation for toggle_removal_ticket to make it simpler to know if a toggle has an associated DEPR or removal ticket.
Additional notes:
- This will be an optional annotation, at least to start.
- Thoughts for documentation enhancements:
- The link could be to a DEPR or another ticket.
- Ideally it would not be a private ticket, but maybe that is ok if the removal is part of the same ticket used to introduce the toggle and it will be very short-lived?
- In this case (or all cases?), all information that would support the removal should be added to the description or warning annotation.
- We should note that for temporary rollout toggles, we should document the intended final value. Note that the toggle default might change as part of the rollout, which means it won't always just be the opposite.
This ticket was spun out of https://github.com/openedx/edx-toggles/issues/283, which listed a number of potential improvements.
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.
Assessment
This issue has not been assessed yet.