Browse files

Add links to pull request instructions

  • Loading branch information...
1 parent 1d4ae9f commit 52fc1559c3a48ea5be58af5893e4f8a27e137a69 @sferik sferik committed May 3, 2012
Showing with 17 additions and 13 deletions.
  1. +17 −13 README.md
View
30 README.md
@@ -113,19 +113,23 @@ your gem version, Ruby version, and operating system. Ideally, a bug report
should include a pull request with failing specs.
## Submitting a Pull Request
-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 <tt>bundle exec rake doc:yard</tt>. If your changes are not 100%
- documented, go back to step 4.
-6. Add specs for your feature or bug fix.
-7. Run <tt>bundle exec rake spec</tt>. 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,
- version, or history file. (If you want to create your own version for some
- reason, please do so in a separate commit.)
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake spec`. If your specs fail, return to step 5.
+7. Run `open coverage/index.html`. If your changes are not completely covered
+ by your tests, return to step 3.
+8. Add documentation for your feature or bug fix.
+9. Run `bundle exec rake doc:yard`. If your changes are not 100% documented, go
+ back to step 8.
+10. Add, commit, and push your changes.
+11. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/
## Supported Ruby Versions
This library aims to support and is [tested against][travis] the following Ruby

0 comments on commit 52fc155

Please sign in to comment.