public
Rubygem
Description: Makes tests easy on the fingers and the eyes
Homepage: http://www.thoughtbot.com/projects/shoulda
Clone URL: git://github.com/thoughtbot/shoulda.git
commit  13f5c2ae8228826f4d12f24a53ecf257659c9c67
tree    cded96279efc22bb720afa261af0d9f75639e139
parent  9f8c29edf3e632cdbc9756f6c5792bdc8cc9494c
shoulda / CONTRIBUTION_GUIDELINES.rdoc
100644 13 lines (9 sloc) 1.548 kb

We’re using GitHub[http://github.com/thoughtbot/shoulda/tree/master] and Lighthouse[http://thoughtbot.lighthouseapp.com/projects/5807], and we’ve been getting any combination of github pull requests, Lighthouse tickets, patches, emails, etc. We need to normalize this workflow to make sure we don’t miss any fixes.

  • Make sure you’re accessing the source from the {official repository}[http://github.com/thoughtbot/shoulda/tree/master].
  • We prefer git branches over patches, but we can take either.
  • If you’re using git, please make a branch for each separate contribution. We can cherry pick your commits, but pulling from a branch is easier.
  • If you’re submitting patches, please cut each fix or feature into a separate patch.
  • There should be a Lighthouse[http://thoughtbot.lighthouseapp.com/projects/5807] ticket for any submission. If you’ve found a bug and want to fix it, open a new ticket at the same time.
  • We’ve got github/lighthouse integration going, so you can update tickets when you commit. {This blog post}[http://hoth.entp.com/2008/4/11/github-and-lighthouse-sitting-in-a-tree] explains the commit options pretty well.
  • Please don’t send pull requests Just update the lighthouse ticket with the url for your fix (or attach the patch) when it’s ready. The github pull requests pretty much get dropped on the floor until someone with commit rights notices them in the mailbox.
  • Contributions without tests won’t be accepted. The file /test/README explains the testing system pretty thoroughly.