the Open edX Platform
This is a community driven project, we together deliver tremendous value to the world. Please go the extra mile to contribute back to the project so that we can accelerate our mission to create the world’s best learning platform.
We welcome contributions to the Open edX code base. You should start by working with the community and the edX Open Source team early, before writing any code. They can help you define requirements, understand the roadmap, and find collaborators.
Our detailed process documentation explains the entire workflow. Understanding these steps will help maintain the highest code quality standards, and make integrating your changes as smooth as possible.
To get going as a code contributor, use this documentation. You will need to complete an individual contributor agreement before submitting a pull request. Your changes will be triaged and reviewed by Open edX committers. This process can take some time. Be patient, and keep the lines of communication open.
If you have any questions, connect with the community on our Forums or Slack.
An Open edX Enhancement Proposal (OEP) (pronounced “oh-epp”) is a document that details a specific technology decision being made by the Open edX community. An OEP can take the form of a best practice, architecture design, or process adjustment. An OEP should provide the use cases and rationales that surround that choice.
OEPs are not the only way for a change to be made to Open edX, however we encourage them for all substantial development projects. Writing an OEP helps you get feedback from the community and from edX, and find other interested parties who can collaborate with you on your contribution.
Small enhancements or patches often don’t need an OEP and can be contributed into the Open edX development workflow with a pull request.
OEP templates are available to help you provide all of the necessary information for your proposal.