Best Practices and Style Guides for Labs

HTML

• Don't put spaces in between a tag and its content:
  • Bad: <div> Lorem Ipsum </div>
  • Good: <div>Lorem Ipsum</div>
• As per COS dev docs, we use 4-space soft tabs for HTML.
• Unless otherwise specified, we use @mdo's style guide for HTML.

SCSS

• As per COS dev docs, we use 4-space soft tabs for (S)CSS.
• Unless otherwise specified here, use the airbnb SCSS styleguide.
• We don't use the Block-Element-Modifier naming convention because we believe that SCSS renders it unnecessary, and that, on small, closely-coordinated teams, we can expect a higher standard of reusability.
• We do use Object Oriented CSS
• Default to osf style whenever there's uncertainty about whether or not something will fit in, look good, or be consistent.

Javascript

Ember

• We use a pod-based component structure, where every entry in the app/components folder is a subdirectory component-name with files template.hbs and component.js inside.
• Every component should have a comment at the beginning of the template with the component's name.