vitornogueira / styleguide Goto Github PK

#

This repository holds the guidelines we follow to write the front-end code of Magnetis.
The documents present a set of rules to follow in order to make sure we write consistent code.

All code in any code-base should look like a single person typed it, no matter how many people contributed.
– Rick Waldon

Arguments over style are pointless. There should be a style guide, and you should follow it.
– Rebecca Murphey

It’s harder to read code than to write it.
– Joel Spolsky

Part of being a good steward to a successful project is realizing that writing code for yourself is a Bad Idea™. If thousands of people are using your code, then write your code for maximum clarity, not your personal preference of how to get clever within the spec.
– Idan Gazit

• JavaScript
• Stylesheet
• Markup

Under /linters you will see configuration files we use to enforce the rules described on the styleguide via code linters.
ATM we use JSHint for Javascript and SCSS lint for Sass with SCSS syntax.

Inside Magnetis we have people using Vim, Sublime Text and TextMate. We make use of the awesome project EditorConfig to help us maintain consistent coding styles between these different editors. The rules are specified on .editorconfig file.

🌳 This is a living project ☀️ so you don't need to agree with everything presented by the documents. Feel free to open an issue to discuss changes and whatnot.

MIT License. Copyright 2014 Magnetis.

You are not granted rights or licenses to the trademarks of the Magnetis, including without limitation the Magnetis logo.

Made with ❤️ at Magnetis