Contributor Guidelines

If you're new to open source, check out our guide on how to add features.

Bugs

• If you see a bug in the code (or the running app), check the GitHub issues and comment on the issue if there is one. If you know how to fix it, go for it! If you don't know how to fix it, please create a new issue. We're using GitHub issues for bug tracking and Pivotal Tracker for new features.

Testing

• Make sure you're writing tests. If you're new to TDD, come to a hack night and pair with someone who's experienced.
• We have awesome notes about from back when Women Who Code was building Bridge Troll. [Check them out](2 15 12 TDD Presentation by George). Courtesy the amazing Judy Tuan.
• Or, ask the list!
• Or, do the Hartl tutorial!

Before submitting a pull request

• Tests. Run all the tests again, just to make sure you didn't break anything.
• You'll want to make sure your fork is totally up to date and rebase your changes on top of it. We have a Git guide to help.

Non-coding ways to help

• Documentation. Help us figure out where our documentation can improve.
• Usability testing. What interactions are bad? Where did the app not do what you thought it would do?