Styleguide: General

General

Welcome to the edX General Front End Styleguide. This document is meant to be referenced alongside the following more detailed styleguides:

• Sass & CSS Styleguide
• HTML Styleguide
• Accessibility Styleguide

---

In general, edX styling should adhere to:

• four (4) spaces indents, no tabs;
• files should be named in all lowercase with - separating legible words (e.g. footer-global.html)
• prefix any partial or included file (a file that should not render on its own) with an underscore (e.g. _system-alerts.scss).

---

Git Etiquette

Never check production-ready files into a codebase's repository including:

• Sass sourcemaps
• compiled CSS files
• compressed assets (CSS and JavaScript files)
• local editor/project namangement files
• local cache-based files

All of these files should be added to either your local global .gitignore file or better yet the edX project's .gitignore file.