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.
Before we can merge your contribution you'll need to sign a Contributor Agreement. We suggest starting that process sooner rather than later.
If you will be working on your contribution during school or work time or are using an github or email account administered by 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. |
We manage our project work in Jira, so you will need to create a Jira account to interact with our tickets.
We recommend starting with tickets in the INCR project because these are tickets that are extremely contained in their scope. You don't need to understand the entire codebase to make a contribution. The success criteria for completing these tickets are very clear. These are great for anyone new to the edX platform because the barrier to entry is low.
Get Started with the edX devstack and follow the information in the ticket you selected to complete it.
Join the #incr Open edX Slack channel to ask questions and get support. There may be also more channels to get technical support mentioned in your specific ticket.
If you get stuck on a particular ticket you should leave a comment on the ticket where you got stuck
We do our best to make these tickets clear and well-contained. But sometimes the fix uncovers larger issues. It's always okay to stop working on a ticket as long as you make it clear that that is what you are doing and try picking up a different ticket. |
When you are ready, create a Pull Request. (Don't forget to sign the Contributor Agreement)
We are always looking to improve this process and make it easier for people to contribute to the platform. Your feedback is a very important part of that process.
Please submit that feedback here