ardarda / icalia_guides

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

Icalia Guides

Icalia Guides is the code convention used at Icalia Labs to create beautiful and maintanable code to get things done.

It includes practices for multiple languages, based on our own experience and experts advice. It also includes how to handle code review when working with teammates.

• Rails
• Ruby
• Git
• Sass && CSS
• Javascript && Coffescript
• Objective-C && Swift
• Open source projects
• NodeJs (in progress)

Primary guidelines:

• Don't reinvent the wheel, reuse code from gems or 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 Icalia 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 at least a week for the team to give feedback.

Credits

Thank you, contributors!

Icalia Guides is maintained by Icalia Labs.

License

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

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