Skip to content

Commit 394c1c3

Browse files
committed
Added Contributing Guidelines
1 parent fcec6c3 commit 394c1c3

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contribution Guidelines #
2+
3+
## Submitting a new issue ##
4+
5+
If you need to open a new issue you *must* provide the following:
6+
7+
1. Version of ClientSideValidations
8+
2. Version of Rails
9+
3. Code snippet from your model of the validations
10+
4. The form code from your template
11+
5. The resulting HTML along with the script tag
12+
13+
Failure to include the above mentioned requirements will result in the
14+
issue being closed.
15+
16+
If you want to ensure that your issue gets fixed *fast* you should
17+
attempt to reproduce the issue in an isolated example application that
18+
you can share.
19+
20+
## Making a pull request ##
21+
22+
If you'd like to submit a pull request please adhere to the following:
23+
24+
1. Your code *must* be tested. Please TDD your code!
25+
2. No single-character variables
26+
3. Two-spaces instead of tabs
27+
4. Single-quotes instead of double-quotes unless you are using string
28+
interpolation or escapes.
29+
5. General Rails/Ruby naming conventions for files and classes
30+
6. *Do not* use Ruby 1.9 hash syntax
31+
7. *Do not* use Ruby 1.9 stubby proc syntax
32+
33+
Plase note that you must adhere to each of the above mentioned rules.
34+
Failure to do so will result in an immediate closing of the pull
35+
request. If you update and rebase the pull request to follow the
36+
guidelines your pull request will be re-opened and considered for
37+
inclusion.

0 commit comments

Comments
 (0)