development_guide.md

Development Guide

Rules for git

We adopt Github Flow

https://guides.github.com/introduction/flow/index.html

Your daily development flow is;

1. Fork develop branch to a topic branch like feature/new-feature. Keep branch name descriptive about what the new feature is.
2. Add some commits to the topic branch.
3. Push the branch to Github any time you like.
4. Create pull request when you think you've done or you want to discuss the new feature.
5. After some improvement on the branch, your branch will be merged to the develop!

Misc

• enable pre-commit hook to avoid commiting trailing spaces.
• diffs contained in one commit should be shown in a page. (i.e. generally smaller commit is better)
• Keep a commit message descriptive.
  • In first line describe what it changes within 80 chars.
  • Second line is blank.
  • If needed, write detailed description in following lines such about what problem it solves, why it's needed, how it solves the problem.

Coding Standards

• Use soft tabs. As usual, 2 spaces.
• In ruby, https://github.com/bbatsov/ruby-style-guide
  • rubocop is useful to tidy up your codes.

Environments

• You probably should use rvm to setup multiple ruby/gem environment.