Styleguide: General

Jump to bottom Edit New page

Brian Talbot edited this page Feb 12, 2015 · 18 revisions

General

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

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).

File Organization

Vendor Files

When possible, we do not:

edit a vendor file directly or change a vendor's source code
change a vendor file's name
split specific vendor files that are bundled together (this means customizing folder paths when referencing vendor files)

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 management 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.