From b09ff69da4f5e3d8cc5437cafec94d9c152a38a0 Mon Sep 17 00:00:00 2001 From: Steve Richert Date: Mon, 23 Apr 2012 16:43:44 -0400 Subject: [PATCH] Update the README --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index e0c98cd..71a4c2e 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,14 @@ Simply builds and verifies OAuth headers -## Submitting a Pull Request +## Contributing 1. Fork the project. 2. Create a topic branch. -3. Implement your feature or bug fix. -4. Add documentation for your feature or bug fix. -5. Run bundle exec rake doc:yard. If your changes are not 100% documented, go back to step 4. -6. Add tests for your feature or bug fix. -7. Run bundle exec rake test. If your changes are not 100% covered, go back to step 6. -8. Commit and push your changes. -9. Submit a pull request. Please do not include changes to the gemspec or version file. (If you want to create your own version for some reason, please do so in a separate commit.) +3. Add failing tests. +4. Add code to pass the failing tests. +5. Run `bundle exec rake`. If failing, repeat step 4. +6. Commit and push your changes. +7. Submit a pull request. Please do not include changes to the gemspec. ## Supported Rubies This library aims to support and is [tested @@ -21,6 +19,7 @@ implementations: * Ruby 1.8.7 * Ruby 1.9.2 * Ruby 1.9.3 +# Ruby head * [JRuby](http://www.jruby.org/) * [Rubinius](http://rubini.us/) @@ -40,4 +39,4 @@ time of a major release, support for that Ruby version may be dropped. ## Copyright Copyright (c) 2010 Steve Richert, Erik Michaels-Ober. -See [LICENSE](https://github.com/laserlemon/simple_oauth/blob/master/LICENSE.md) for details. +See [LICENSE](https://github.com/laserlemon/simple_oauth/blob/master/LICENSE) for details.