The Monterail's Rules

Following document contains development guidelines for Monterail.com, LLC.

General

1. Leave the campground cleaner than you found it.
2. Configure your editor to automatically strip trailing whitespaces.

Git

Use git up tool

especially if you're not experienced with git. It keeps the commit history clean.

gem install git-up
git config --global git-up.bundler.check true
git config --global git-up.bundler.autoinstall true
git config --global git-up.fetch.all true
git config --global git-up.rebase.arguments --preserve-merges

If you're comfortable with Git commands, use git config --global branch.autosetuprebase always

Follow the rules described in our Git flow

JavaScript

• "classes are for designers", so don't scope with ids and classes in js. JavaScript developers should use data-* attributes, js-* prefix for classes or role attribute (go to discussion)
• prefix jQuery objects with $ sign unless you are working with angular project (go to discussion)

JS on Rails

• use callbacks instead of low-level $.ajax when possible
• move javascript tags from HEAD to the bottom (go to discussion)

Rails

Ruby

• avoid rescuing StandardError and Exception

HTML

Use consistent class names and markup for HTML components

For basic ones, use twitter bootstrap 2 conventions. For example don't use <div class="crumbs"> for breadcrumbs instead of <ul class="breadcrumb"></ul>. This also concerns layout, forms, buttons, flash messages, navigation and others.

If possible, document new markup proposals in our styleguide.

For proper forms markup, install the formtastic-bootstrap gem.

Coding / development enrivonments

Contribution to this repository

According to this issue we agreed to:

• declare if he/she wants to participate in issues tagged with given word, for example #ruby or #css. Then all issues / pull-request would be tagged appropriately.
• if so, he/she would be obligated to comment on issue or at least give +1 or no opinion comment for example until week after issue has been created.
• the idea is subscribed persons would be obligated to comment. we will mention them in such cases.
• final decision for merging is for CTO
• it's of couse possible for non-declared person to participate. That list would help us determine if issue is ready to be accepted or it needs more discussion / time (for example if everyone would vote "no opinion").

Here is current list of tags along their participants:

• #ruby - @jandudulski, @sheerun, @chytreg, @teamon, @szajbus, @Ostrzy
• #js - @jandudulski, @sheerun, @chytreg, @szajbus, @porada, @Ostrzy
• #git - @jandudulski, @sheerun, @teamon, @szajbus, @Ostrzy, @porada
• #html - @jandudulski, @sheerun, @porada, @venticco, @Ostrzy
• #unix - @jandudulski, @sheerun, @teamon, @szajbus, @porada
• #css - @jandudulski, @sheerun, @porada, @venticco
• #design - @jandudulski, @sheerun, @design, @venticco, @szymo, @porada

Pull requests, issues, and comments from third party are welcome too!