Style Guides

EditorConfig

EditorConfig is a standard to let editors know about the basic settings for the project. These include indentation type (spaces vs. tabs) and indentation width for example. For a full list of fully and partially supported properties, see the project wiki. All A+ LMS repositories should include an .editorconfig.

If the project does not include an .editorconfig, then one should be download from .editorconfig. Remember to send updates to upstream too!

Style Guides for major languages

A+ Design System showcases consistent, robust and accessible components and styles for building in the A+ ecosystem.

• CSS and SCSS
  • indent: tab
  • identifier names: variables $brand-success and --brand-success, classes use BEM
• (GNU) gettext translations
  • Frequently used translations
• HTML
  • indent: tab
• JavaScript
  • indent: 2 spaces
  • max line length:, soft limit 79, hard limit 99
  • identifier names: PascalCase for classes; camelCase for variables, functions and methods
• Python, Django and other Python frameworks
  • indent: 4 spaces
  • max line length: text blocks 72, soft limit 79, hard limit 119
  • identifier names: PascalCase for classes; snake_case for variables, functions and methods