openedx / openedx/openedx-proposals
Accept or Obsolete "Provisional" OEPs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 50
- Forks
- 47
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 2
Description
Several OEPs were authored aspirationally, and then never implemented. Other were partially implemented, but have stalled or diverged from reality. Yet others should be followed by the community, but are erroneously marked as "Provisional".
In order to establish OEPs as a trustworthy source of documentation, we should mark OEPs that never came to be as "Replaced" or "Obsolete" (whichever or is more appropriate). We should revise and "Accept" OEPs that are still relevant but mismatched with reality. We should simply "Accept" OEPs that are for all practical purposes adopted by the community.
Sub-issues have been made for all the found Provisional OEPs & ADRs.
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
Review the provisional OEPs and ADRs identified by the sub-issues, then compare each with its current implementation and community use. Determine whether each should be Accepted, Replaced, or Obsolete, and update the relevant proposal documentation and status. Done means every identified provisional document has an appropriate, evidence-based status.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100