diff --git a/README.md b/README.md index bba6723..ffab295 100644 --- a/README.md +++ b/README.md @@ -40,11 +40,62 @@ Starting from version `0.1.0` this gem follows [semantic versioning](http://semv Contributing ------------ -Once you've made your great commits: +In the spirit of [free software][free-sw], **everyone** is encouraged to help +improve this project. -1. Fork m2r -2. Create a topic branch - `git checkout -b my_branch` -3. Push to your branch - `git push origin my_branch` -4. Send a pull request +[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html +Here are some ways *you* can contribute: + +* by using alpha, beta, and prerelease versions +* by reporting bugs +* by suggesting new features +* by writing or editing documentation +* by writing tests +* by writing code (**no patch is too small**: fix typos, add comments, clean up + inconsistent whitespace) +* by refactoring code +* by closing [issues][] +* by reviewing patches + +[issues]: https://github.com/perplexes/m2r/issues + +Submitting an Issue +------------------- + +We use the [GitHub issue tracker][issues] to track bugs and features. Before +submitting a bug report or feature request, check to make sure it hasn't +already been submitted. When submitting a bug report, please include a [Gist][] +that includes a stack trace and any details that may be necessary to reproduce +the bug, including your gem version, Ruby version, and operating system. +Ideally, a bug report should include a pull request with failing tests. + +[gist]: https://gist.github.com/ + +Submitting a Pull Request +------------------------- + +1. [Fork the repository.][fork] +2. [Create a topic branch.][branch] +3. Add tests for your unimplemented feature or bug fix. +4. Run `bundle exec rake`. If your test pass, return to step 3. +5. Implement your feature or bug fix. +6. Run `bundle exec rake`. If your tests fail, return to step 5. +7. Add, commit, and push your changes. +8. [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](http://travis-ci.org/perplexes/m2r) the following Ruby implementations: + +- Ruby 1.9.2 +- Ruby 1.9.3 +- JRuby +- Rubinius