kotovalexarian-likes-github
/
activerecord-hackery--ransack
mirror of https://github.com/activerecord-hackery/ransack.git
1
0
Fork 0
Code Releases Activity

Improve the Contributing Guide

This commit is contained in:
Jon Atack 2014-05-06 10:59:42 +02:00
parent e072708cf2
commit 4ae224d2ce
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
CONTRIBUTING.md
View File

@ -5,8 +5,8 @@ Ransack is an open source project and we encourage contributions.
When filing an issue on the Ransack project, please provide these details:
* A comprehensive list of steps to reproduce the issue.
* The version of Ransack *and* the version of Rails.
* Any relevant stack traces ("Full trace" preferred)
* The version of Ransack *and* the version of Rails and Ruby.
* Any relevant stack traces ("Full trace" preferred).
In 99% of cases, this information is enough to determine the cause and
solution to the problem that is being described.
@ -20,6 +20,10 @@ if the information requested is provided.
We gladly accept pull requests to fix bugs and, in some circumstances, add new
features to Ransack.
Before issuing a pull request, please make sure that all specs are passing,
that any new features have test coverage, and that anything that breaks
backward compatibility has a very good reason for doing so.
Here's a quick guide:
1. Fork the repo.
@ -38,7 +42,9 @@ a test!
5. Push to your fork and submit a pull request. If the changes will apply
cleanly to the latest stable branches and master branch, you will only need
to submit one pull request.
to submit one pull request. If the pull request only contains documentation
changes, please add `[skip ci]` to the commit message so that the Travis test
suite does not needlessly run.
At this point you're waiting on us. We like to at least comment on, if not
accept, pull requests within three business days (and, typically, one business
@ -55,11 +61,13 @@ taken straight from the Ruby on Rails guide:
Syntax:
* Two spaces, no tabs.
* 80 characters per line.
* No trailing whitespace. Blank lines should not have any space.
* Prefer &&/|| over and/or.
* `MyClass.my_method(my_arg)` not `my_method( my_arg )` or my_method my_arg.
* `a = b` and not `a=b`.
* `a_method { |block| ... }` and not `a_method { | block | ... }`
* `a_method { |block| ... }` and not `a_method { | block | ... }` or
`a_method{|block| ...}`.
* Follow the conventions you see used in the source already.
And in case we didn't emphasize it enough: we love tests!