Open edX Developer’s Guide

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.

Courses on the basics of the Open edX software, the Open edX community, and learning to be an effective Open edX developer can all be found on our Open edX learning site, training.openedx.org.

• 1. Open edX Platform Architecture
  • 1.1. Overview
  • 1.2. Key Components
• 2. Contributing to the Open edX Project
  • 2.1. Process for Contributing Code
  • 2.2. Contributing
  • 2.3. Landing Your Work
  • 2.4. Code Considerations
  • 2.5. Overview of Review Process for Community Contributions
  • 2.6. Pull Request Status Guide
  • 2.7. Core Contributors to the Open edX Project
• 3. Extending the edX Platform
  • 3.1. Options for Extending the edX Platform
  • 3.2. Integrating XBlocks with edx-platform
• 4. Testing
  • 4.1. Open edX Browser Support
  • 4.2. GitHub Actions
  • 4.3. Code Coverage
  • 4.4. Code Quality
• 5. Analytics
  • 5.1. Event Tracking
  • 5.2. Other Tracking Systems
• 6. Writing Good Code
  • 6.1. Django Good Practices
• 7. Writing Code for Internationalization
  • 7.1. Internationalization Coding Guidelines
• 8. Preventing Cross Site Scripting Vulnerabilities
  • 8.1. Preventing Cross Site Scripting Vulnerabilities
  • 8.2. Preventing XSS by Stripping HTML Tags
  • 8.3. Preventing XSS in Django Templates
  • 8.4. Preventing XSS in React
• 9. Language Style Guidelines
  • 9.1. Open edX JavaScript Style Guide
  • 9.2. Open edX Python Style Guide
  • 9.3. Open edX Sass Style Guide

---

Feedback