Contributing

Style Guide

Please stick to the coding style that already exists in Defender. When in doubt, check out bbatsov's style guide (with one exception: Use TomDoc instead of RDoc).

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.

Asking Questions

• We have a mailing list for discussions. To join the list simply send an email to defender@librelist.com. This will subscribe you and send you information about your subscription, including unsubscribe information.

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 dvyjones/defender
• 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.