Improve CONTRIBUTING.md guide.

Add some line breaks(better when reading in the editor) and use markdown syntax for ordered lists.
Also, added a title.
This commit is contained in:
Sadjow Leão 2014-01-28 23:08:34 -03:00
parent ea5ceb7dfa
commit 6bf83a1932
1 changed files with 16 additions and 5 deletions

View File

@ -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!