Code Monkey home page Code Monkey logo

guidelines's Introduction

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

JS on Rails

Ruby

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.

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!

guidelines's People

Contributors

sheerun avatar jandudulski avatar bartoszrega avatar teamon avatar porada avatar szajbus avatar

Watchers

 avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.