Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Merge pull request #977 from sadjow/improve-contributing-guide

Improve CONTRIBUTING guide.
  • Loading branch information...
commit 32019827798eddbecc19676d69eb406a4f3902cc 2 parents ea5ceb7 + 6bf83a1
@rafaelfranca rafaelfranca authored
Showing with 16 additions and 5 deletions.
  1. +16 −5 CONTRIBUTING.md
View
21 CONTRIBUTING.md
@@ -1,11 +1,22 @@
-### Please read before contributing
+## Contributing
-1) If you have any questions about SimpleForm, search the [Wiki](https://github.com/plataformatec/simple_form/wiki) or use the [Mailing List](https://groups.google.com/group/plataformatec-simpleform) or [Stack Overflow](http://stackoverflow.com/questions/tagged/simple_form). Do not post questions here.
+1. If you have any questions about Simple Form, search the
+[Wiki](https://github.com/plataformatec/simple_form/wiki) or
+use the [Mailing List](https://groups.google.com/group/plataformatec-simpleform)
+or [Stack Overflow](http://stackoverflow.com/questions/tagged/simple_form).
+Do not post questions here.
-2) If you find a security bug, **DO NOT** submit an issue here. Please send an e-mail to [opensource@plataformatec.com.br](mailto:opensource@plataformatec.com.br) instead.
+2. If you find a security bug, **DO NOT** submit an issue here.
+Please send an e-mail to [opensource@plataformatec.com.br](mailto:opensource@plataformatec.com.br)
+instead.
-3) Do a small search on the issues tracker before submitting your issue to see if it was already reported / fixed. In case it was not, create your report including Rails and SimpleForm versions. If you are getting exceptions, please include the full backtrace.
+3. Do a small search on the issues tracker before submitting your issue to
+see if it was already reported or fixed. In case it was not, create your report
+including Rails and Simple Form versions. If you are getting exceptions, please
+include the full backtrace.
-That's it! The more information you give, the more easy it becomes for us to track it down and fix it. Ideal scenario would be adding the issue to SimpleForm test suite or to a sample application.
+That's it! The more information you give, the more easy it becomes for us to
+track it down and fix it. Ideal scenario would be adding the issue to Simple Form
+test suite or to a sample application.
Thanks!
Please sign in to comment.
Something went wrong with that request. Please try again.