Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Improve Contribute section in README

  • Loading branch information...
commit 676a56f2d1f8bb3e8305a217bdcfdac701d0661d 1 parent 3c4b7cc
@remiprev authored
Showing with 15 additions and 4 deletions.
  1. +15 −4 README.md
View
19 README.md
@@ -445,9 +445,22 @@ Category.all
* Better error handling
* Better API documentation (using YARD)
-## Contributors
+## Contribute
-Feel free to contribute and submit issues/pull requests [on GitHub](https://github.com/remiprev/her/issues) like these fine folks did:
+Yes please! Feel free to contribute and submit issues/pull requests [on GitHub](https://github.com/remiprev/her/issues).
+
+### How to contribute
+
+* Fork the repository
+* Implement your feature or fix
+* Add examples that describe it (in the `spec` directory)
+* Make sure `bundle exec rake spec` passes after your modifications
+* Commit (bonus points for doing it in a `feature-*` branch)
+* Send a pull request!
+
+### Contributors
+
+These fine folks helped with Her:
* [@jfcixmedia](https://github.com/jfcixmedia)
* [@EtienneLem](https://github.com/EtienneLem)
@@ -455,8 +468,6 @@ Feel free to contribute and submit issues/pull requests [on GitHub](https://gith
* [@tysontate](https://github.com/tysontate)
* [@nfo](https://github.com/nfo)
-Take a look at the `spec` folder before you do, and make sure `bundle exec rake spec` passes after your modifications :)
-
## License
Her is © 2012 [Rémi Prévost](http://exomel.com) and may be freely distributed under the [MIT license](https://github.com/remiprev/her/blob/master/LICENSE). See the `LICENSE` file.
Please sign in to comment.
Something went wrong with that request. Please try again.