Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

This article is for people who are interested in contributing code to the Open edX open source project space but don't know what contributions would be most valuable 

Instructions

  1. You'll need to sign a Contributor Agreement before we can merge your contribution, so we suggest starting that process sooner rather than later.
    1. If you are contributing as an individual go ahead and sign the Individual Contributor Agreement.
    2. If your work will be contributed as part of a company or institution email legal@edx.org.  More details about how to know if you fall into this category in the FAQ below.
  2. Find an INCR ticket to work on from the INCR Epics section of the INCR project dashboard.
    1. The INCR tickets are grouped together into Jira epic tickets.  Select a project from the dashboard and navigate to "Stories in this epic" to see all of the tasks associated with it.
  3. Join the #incr Open edX Slack channel to ask questions and get support.
  4. Start working on your ticket.  (Getting Started)
    1. Comment on the ticket that you have started working on it.
    2. The ticket should be self documenting as to what steps to take to complete it.
    3. If you get stuck on a particular ticket you should leave a comment on the ticket where you got stuck.
  5. When you are ready, create a Pull Request.  Be sure to reference which INCR ticket your code is resolving.
  6. Mention @edx/incr-reviewers in the PR
  7. Communicate with the reviewer about the code and respond to feedback.
  8. Once your PR is approved it will be merged by the reviewer.
  9. Celebrate 🎉


FAQ

How do I know if I should sign the individual contributor agreement or contribute as part of an larger organization?

If you will be working on your contribution during school or work time or are using an account administered that organization you likely fall under our larger organization agreements.  You may also be under contractual obligation from your employer that all code you write is their property or may be their property if written on a machine that they purchased.  If you have any questions about whether you should sign the individual contributor agreement or contribute as part of an organization email your situation to legal@edx.org and they will help find the right agreement for you.



  • No labels