# OEP-1 Update: "Needs Revision" status addition

**URL:** <https://discuss.openedx.org/t/oep-1-update-needs-revision-status-addition/13039>\
**Category:** Architecture\
**Created:** [May 17, 2024, 9:07pm UTC](https://discuss.openedx.org/t/oep-1-update-needs-revision-status-addition/13039 "2024-05-17T21:07:39Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![sarina](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.openedx.org/sarina/32/2308_2.png) [@sarina](https://discuss.openedx.org/u/sarina)\
**Post date:** [May 17, 2024, 9:07pm UTC](https://discuss.openedx.org/t/oep-1-update-needs-revision-status-addition/13039/1 "2024-05-17T21:07:39Z")

</div>

## Review Period

Review Period 17 May - 27 May 2024

## Pull Request

> <https://github.com/openedx/open-edx-proposals/pull/586>
>
> Over time, some OEPs may stay relevant - for example, they may have many
> sectio…ns or core ideas that are still relevant to the project - while containing
> many details that have become stale over time. When we are in agreement that the
> OEP needs updating, we use this status to indicate to those browsing the OEPs
> that this particular one requires some renewed attention.
> 
> When changing status to "Needs Revision", a row titled "Revision Ticket" should
> be added to the preamble (directly under the status field) that directs to the
> GitHub issue or draft pull request in the \`\`open-edx-proposals\`\` repository that
> describes what about the OEP that needs revisioning.
> 
> An example is added with OEP-45. OEP-45 is directionally correct and we shouldn't mark it as \_obsolete\_ - it contains many great ideas. However it very much needs revision. We've captured the revision needs in https://github.com/openedx/open-edx-proposals/issues/587 and linked that issue to the OEP.
> 
> It is not always feasible that we find something wrong in an OEP and have the time right then and there to update the OEP. This status is a nod to that reality and a signpole to community members that they should tread carefully.

## Reasoning

Over time, some OEPs may stay relevant - for example, they may have many  
sections or core ideas that are still relevant to the project - while containing  
many details that have become stale over time. When we are in agreement that the  
OEP needs updating, we use this status to indicate to those browsing the OEPs  
that this particular one requires some renewed attention.

When changing status to “Needs Revision”, a row titled “Revision Ticket” should  
be added to the preamble (directly under the status field) that directs to the  
GitHub issue or draft pull request in the `open-edx-proposals` repository that  
describes what about the OEP that needs revisioning.

Please add comments and thoughts on the PR: [Add a Needs Revision status for OEPs by sarina · Pull Request #586 · openedx/open-edx-proposals · GitHub](https://github.com/openedx/open-edx-proposals/pull/586)
