Permalink
Browse files

Updated README and contribution guide

  • Loading branch information...
1 parent 401ef1f commit 74c6c3a9e8b46a245dda6cc9e8c41797a2f29d65 @bcardarella bcardarella committed Oct 9, 2012
Showing with 49 additions and 14 deletions.
  1. +37 −0 CONTRIBUTING.md
  2. +12 −14 README.md
View
37 CONTRIBUTING.md
@@ -0,0 +1,37 @@
+# Contribution Guidelines #
+
+## Submitting a new issue ##
+
+If you need to open a new issue you *must* provide the following:
+
+1. Version of ClientSideValidations
+2. Version of Rails
+3. Code snippet from your model of the validations
+4. The form code from your template
+5. The resulting HTML along with the script tag
+
+Failure to include the above mentioned requirements will result in the
+issue being closed.
+
+If you want to ensure that your issue gets fixed *fast* you should
+attempt to reproduce the issue in an isolated example application that
+you can share.
+
+## Making a pull request ##
+
+If you'd like to submit a pull request please adhere to the following:
+
+1. Your code *must* be tested. Please TDD your code!
+2. No single-character variables
+3. Two-spaces instead of tabs
+4. Single-quotes instead of double-quotes unless you are using string
+ interpolation or escapes.
+5. General Rails/Ruby naming conventions for files and classes
+6. *Do not* use Ruby 1.9 hash syntax
+7. *Do not* use Ruby 1.9 stubby proc syntax
+
+Plase note that you must adhere to each of the above mentioned rules.
+Failure to do so will result in an immediate closing of the pull
+request. If you update and rebase the pull request to follow the
+guidelines your pull request will be re-opened and considered for
+inclusion.
View
26 README.md
@@ -1,6 +1,8 @@
# ClientSideValidations-SimpleForm #
-[![Build Status](http://travis-ci.org/dockyard/client_side_validations-simple_form.png)](http://travis-ci.org/dockyard/client_side_validations-simple_form)
+[![Build Status](https://secure.travis-ci.org/dockyard/client_side_validations-simple_form.png?branch=2-0-stable)](http://travis-ci.org/dockyard/client_side_validations-simple_form)
+[![Dependency Status](https://gemnasium.com/dockyard/client_side_validations-simple_form.png?travis)](https://gemnasium.com/dockyard/client_side_validations-simple_form)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/dockyard/client_side_validations-simple_form)
[SimpleForm](https://github.com/plataformatec/simple_form) plugin for [ClientSideValidations](https://github.com/bcardarella/client_side_validations)
@@ -17,7 +19,7 @@ gem 'client_side_validations-simple_form'
Order matters here. `SimpleForm` and `ClientSideValidations` need to be
required **before** `ClientSideValidations-SimpleForm`.
-[Follow the remaining installation instructions for ClientSideValidations](https://github.com/bcardarella/client_side_validations/README.markdown)
+[Follow the remaining installation instructions for ClientSideValidations](https://github.com/bcardarella/client_side_validations/tree/3-2-stable/README.md)
Add the following line to `app/assets/javascripts/application.js`
@@ -61,26 +63,22 @@ Per-input options are done with `:validate`
[Brian Cardarella](http://twitter.com/bcardarella)
+[We are very thankful for the many contributors](https://github.com/dockyard/client_side_validations-simple_form/graphs/contributors)
+
## Versioning ##
This gem follows [Semantic Versioning](http://semver.org)
-Major and minor version numbers will follow `SimpleForm`'s major and
+Major and minor version numbers will follow `Rails`'s major and
minor version numbers. For example,
-`client_side_validations-simple_form-1.5.0` will be compatible with
-`~> simple_form-1.5.0`
+`client_side_validations-simple_form-2.0.0` will be compatible up to
+`~> simple_form-2.0.0`
## Want to help? ##
-Stable branches are created based upon each minor version. Please make
-pull requests to specific branches rather than master.
-
-Please make sure you include tests!
-
-Unles Rails drops support for Ruby 1.8.7 we will continue to use the
-hash-rocket syntax. Please respect this.
-
-Don't use tabs to indent, two spaces are the standard.
+Please do! We are always looking to improve this gem. Please see our
+[Contribution Guidelines](https://github.com/dockyard/client_side_validations-simple_form/blob/master/CONTRIBUTING.md)
+on how to properly submit issues and pull requests.
## Legal ##

0 comments on commit 74c6c3a

Please sign in to comment.