Add a Needs Revision status for OEPs #586
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
feanil
approved these changes
May 17, 2024
sarina
force-pushed
the
sarina/needs-revision
branch
3 times, most recently
from
6e936f9
to
100fb31
Compare
sarina
changed the title
felipemontoya
approved these changes
May 21, 2024
pomegranited
approved these changes
May 23, 2024
| @@ -245,7 +245,7 @@ OEP Status | |||
| "Under Review" -> { "Deferred" "Provisional" } [dir=both] | |||
| "Under Review" -> { "Accepted" "Rejected" "Withdrawn" } | |||
| "Accepted" -> "Final" | |||
There was a problem hiding this comment.
Once an OEP is in "Needs Revision", where can it go from there? I haven't tried rendering it, but maybe this is enough?
Suggested change
| "Accepted" -> "Final" | |
| "Accepted" -> "Final" | |
| "Needs Review" -> "Final" |
There was a problem hiding this comment.
Good point, and, it's tough because (a) Needs Review should just wrap around to Under Review (and all its possible states), and (b) GitHub isn't rendering the graph in preview and I'm having some issue with my local env at the moment.
There was a problem hiding this comment.
Ha! I forgot we have a build :) I added like this:
How does that look? I don't love it but otoh I love how it's autogenerated!
There was a problem hiding this comment.
Oh yes, autogenerated FTW!
That looks good enough.
sarina
force-pushed
the
sarina/needs-revision
branch
from
100fb31
to
42cc472
Compare
sarina
force-pushed
the
sarina/needs-revision
branch
from
42cc472
to
12dc80b
Compare
sarina
force-pushed
the
sarina/needs-revision
branch
from
12dc80b
to
86e4fa4
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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-proposalsrepository thatdescribes 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 #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.