Developer’s Guide for Open edX

Welcome to the Open edX Developer’s Guide. This guide should be used as a reference manual; it covers everything from high level system architecture to practical advice on testing and coding for internationalization.

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.

• Open edX Platform Architecture
  • Overview
  • Key Components
• Contributing to the Open edX Project
  • Process for Contributing Code
  • Contributing Code to the Open edX Project
  • Open edX Git Workflows
  • Landing Your Work
  • Code Considerations
  • Overview of Review Process for Community Contributions
  • Pull Request Status Guide
  • Core Contributors to the Open edX Project
• Extending the edX Platform
  • Options for Extending the Open edX Platform
  • Integrating XBlocks with edx-platform
• Testing
  • Open edX Browser Support
  • GitHub Actions
  • Code Coverage
  • Code Quality
• Analytics
  • Event Tracking
  • Other Tracking Systems
• Writing Good Code
  • Django Good Practices
  • Frontend Good Practices
• Writing Code for Internationalization
  • Internationalization Coding Guidelines
• Preventing Cross Site Scripting Vulnerabilities
  • Preventing Cross Site Scripting Vulnerabilities
  • Preventing XSS by Stripping HTML Tags
  • Preventing XSS in Django Templates
  • Preventing XSS in React
• Language Style Guidelines
  • Open edX JavaScript Style Guide
  • Open edX Python Style Guide
  • Open edX Sass Style Guide

---

Feedback