/guides

A set of rules we use at @icalialabs to build better software

Primary LanguageRuby

Guides

Icalia Guides is the programming style used at Icalia Labs to create beautiful and maintainable code.

We algo provide a bunch of how to articles at the wiki to answer the most frequently asked questions.

Primary guidelines:

  • Don't reinvent the wheel reuse code from plugins
  • Be consistent
  • Be kind with your teammate
  • Don't violate any guideline, unless you can convince another teammate of doing so

Language used on Guides:

  • "Choose" means that there could be multiple options to choose from
  • "Use" is a positive declaration
  • "Never" there is no reason why you are breaking the statement
  • "Abstain" don't do it unless you have a good reason

Contributing

Everyone is freely to collaborate and submit pull request if needed.

if you have commit access, you should wait not more than a week for the team to give feedback.

Credits

Thank you, contributors!

Icalia Labs

Guides is maintained by Icalia Labs.

License

Guides is © 2015 Icalia Labs. It is distributed under the Creative Commons Attribution License.

The names and logos for Icalia Labs are trademarks of Icalia Labs.