Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Many people want to make contributions to Open edX that are larger than a single Open Source Pull Request (OSPR).  Often, these larger contributions touch several parts of the platform and require collaboration from multiple people inside and outside of edX.  To help keep track of these collaborations, and make sure we’re giving you the input you need, we’ve developed this process.

Throughout this document, we'll reference "the open source team".  That's the name of a group at edX whose job it is to grow the Open edX platform and community.  Currently it consists of Ned Batchelder, Joel Barciauskas, Shauna Gordon-McKeon and George SongJohn Mark Walker, Matthew DuBose and Natalia Berdnikov.  You can reach all of us by emailing oscm@edx.org.  Once you've begun this process, your team will be assigned an open source team liaison.  That person will be your main point of contact throughout the process – if you're ever confused or have questions, please reach out to them.

...

In this step, you will plan out in detail your implementation of the design specified in Step 2.   We don’t want to micromanage how individual teams communicate around implementation, so there is no required document for this step.  We do, however, have a template Implementation Planning Document that you can use, and you can see examples of implementation planning documents belowThe main output of this phase is an implementation planning document.  We have provided a template document, the Implementation Planning Template

We recognize that teams may differ in how they prefer to communicate and plan.  Please check with the teams you're working with at edX that the template document works for them before going through the effort of filling it out.  If the team wants to modify the template, or use an alternate process, that's totally okay.

Unlike the goals and design documents, the implementation planning document will be a living document.  You should add links to OSPRs as you create them, and you may find that as you actually do the implementation (Step 4), that your plans change.  You do not need to seek formal re-review, but please make sure that your contacts at edX are getting notified of any significant changes.

...

Add your contribution to the index, add links to in-progress documents, and upload finished documents on the Significant Contribution Index page.

Templates

Goals Document Template

Design Document Template

...

...