openedx / openedx/openedx-filters
Document deprecation process
Open
@mariajgrimaldi is already working on this.
Since Mar 8, 2023.
documentation
- Dominant language
- Python
- Stars
- 10
- Forks
- 28
- Avg merge
- 3d 8h
- Merged PRs (30d)
- 8
Description
Description
As a result of this PR, which adds a filter to a legacy page, we must decide and document a deprecation strategy. How should we monitor this effort?
@felipemontoya suggests:
- for the page is being removed, I am notified for one stable release
- when possible, the filter is used in the new replacement page or the API that MFEs call for the same feature. Otherwise a different but equivalent filter exists for the replacement page.
A strategy I agree with, For now, we will track each filter to check which ones are candidates for deprecation, so we can track them better.
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.