|Author||Calen Pennington <firstname.lastname@example.org> Feanil Patel <email@example.com>|
|Arbiter||Calen Pennington <firstname.lastname@example.org>|
Proposes a standard format for repository metadata for Open edX projects.
One of the primary goals for Best Practice OEPs is to standardize techniques and tools across Open edX repositories. However, without tooling, it will be difficult to move all of the repositories in the same direction (and hard to validate which ones have been updated). This OEP exists to fill that gap. By providing a standard format for metadata about accordance to Best Practice OEPs, tools can be developed in the future to report on the current status of all of the Open edX repositories, and how well they follow the Best Practices listed in the OEPs.
Bear in mind that particular classes of Open edX repositories may have different Best Practices. The practices that apply to an XBlock may not be the same as those that apply to a standalone Django service or to a Django app.
Each repo in the Open edX system will include a file
openedx.yaml, with the
owner: string (required unless
supporting_teams: list of strings (optional)
nick: string (optional)
tags: list of strings (optional)
oeps: dictionary (optional)
oep-n). Each value would be one of
False, or a reason dictionary.
Falsewould indicate accordance (or lack thereof) with the specified OEP. A reason dictionary provides more detailed information. It can contain a boolean
state, a boolean
applicable, and a string
reason. If the OEP is not applicable to this repository, the reason dictionary can simply contain a single value of
reasonvalue must be included that explains why. If the
reasoncan optionally provide more information. The
reasonvalue will be displayed in reporting tools. If an OEP isn’t listed in the
oepsdictionary, then it is assumed to be
False, unless the reporting tool can auto-detect accordance.
openedx-release: defined by OEP-10.
archived: boolean (optional)
True, this specifies that this repository is archived and no longer maintained by edX.
For example, in the edx-platform repo, the file might look like:
# openedx.yaml --- owner: nasthagiri supporting_teams: - platform-core - platform-core-extensions - platform-authn - platform-courseware nick: edx tags: - core - xblock - lms - studio oeps: oep-314: True # edx-platform uses django 3.14 oep-42: state: False reason: This OEP doesn't actually exist oep-2: state: True # no reason is required since this is True oep-100: applicable: False # state is not required since the OEP is not applicable reason: This OEP contains best practices for C++ which is not used in edx-platform oep-101: applicable: False # reason is not required since it's almost always just a redundant statement about it not being applicable
The keys in
openedx.yaml were derived from existing repository metadata collected
The design of the
oeps dictionary was guided by a couple of use cases:
tags structure is very open ended but there are a few tags that are currently
in wide use and are provided here so that they can be used consistently.
archivedand relax the requirement for an owner if
applicablekey in the reason dictionary.
nickkeys in the