Contributing to the Open edX Project

This reference guide to contributing code to the Open edX project is comprehensive and covers all you might encounter in the process of writing, submitting, and getting reviews on your pull requests. Before diving into this guide, you might find it useful to check out the Quick Start: First Open edX Pull Request, and its follow-up, Quick Start: So You Want to Contribute to Open edX.

Also useful is the Intro to the Open edX Project & Contributing onboarding course as well as the Open edX Developer’s Onboarding course.

• Process for Contributing Code
  • General Guidelines
• Contributing Code to the Open edX Project
  • Product Review Process & Product Roadmap
  • Getting Preliminary Feedback
  • Start Coding!
• Open edX Git Workflows
  • Using A Personal Fork
  • Squashing Changes
  • Rebasing Your Branch
  • Further Git Resources
• Landing Your Work
  • Describe your changes
  • Limit your scope
  • Licensing
  • Testing
  • Commit Messages and Rebasing
  • Code Review
• Code Considerations
  • Basic Code Quality
  • Feature Documentation
  • Feature Rollout Concerns
  • Operational Impact on Early Deployers
  • Open edX Named Releases
• Overview of Review Process for Community Contributions
  • Community Contribution Project Managers
  • FAQs about your Pull Request
• Pull Request Status Guide
  • Contribution Board Statuses
  • Contribution Board Labels
• Core Contributors to the Open edX Project
  • Resources

---

Feedback