Skip to content
This repository was archived by the owner on Aug 1, 2022. It is now read-only.

contributing

joelmoss edited this page Jan 19, 2012 · 1 revision

Style Guide

Please stick to the coding style that already exists in Strano. When in doubt, check the excellent RUBY-STYLE document.

Adding Code

  • Document every method you add.
  • Write a test for every method you add.
  • If your addition is something you wish you had read in the README, add it to the README.
  • Wrap your lines at 80 characters. If your code can’t fit, refactor.

Bugs

  • The Issue Tracker is the perfect place for bugs.
  • Have a large stack trace you want to paste in? Create a Gist and link to it in your issue, or, if you’re on OS X, try the handy pbindent command.

Creating a Patch

  • Fork joelmoss/strano
  • Create a topic branch: `git checkout -b my_fix`
  • Make your changes
  • Push your branch: `git push origin my_fix`
  • Open an Issue referencing your branch.
  • Please do not push to `master` on your fork. This will make everyone’s life easier.

Clone this wiki locally