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.

...

Involvement by edX: edX does not need to be involved until you submit the goals document, however we encourage you to let us know as soon as you get started, so we can help you align your goals with the overall project goals to help avoid any potential issues later. The product team, in particular, can provide advice on which goals may be more productive to pursue than others.  At some point during step 1, a member of the open source team will become your team's liaison.

Proceed to the next step when: you have filled out the goals document, sent it to oscm@edx.org, and received a go-ahead from the open source team.  Once the goals document is finished, it will be added to the Significant Contribution Index. 

Step 2: Design

The next step of the process is the design phase.  Here, you will make high-level architectural decisions which will help you meet the goals you formalized in Step 1.

...

Proceed to the next step when:The edX  Your open source team liaison will help you identify all of the internal teams which need to approve your design.  Once they've given you a thumbs up, the design document will be added to the Significant Contribution Index and you can continue to Step 3.

...

Proceed to the next step when:  When you're finished with implementation, please send a note to the your open source team liaison so we can mark the work as resolved and upload the implementation planning doc to the Significant Contribution Index for future reference.  Congratulations, and thank you for your work! (smile)

...

...