Skip to content
This repository
Newer
Older
100644 59 lines (40 sloc) 1.866 kb
3e9527a4 »
2011-07-22 a contributing guide
1 We love pull requests. Here's a quick guide:
2
a4a0034b »
2013-01-16 Add Vagrant configuration.
3 ## Dependencies
df392683 »
2012-01-15 add imagemagick dependency to contributing guide
4
5 Some of the tests depend on the `identify` command that comes with Imagemagick.
a4a0034b »
2013-01-16 Add Vagrant configuration.
6 Imagemagick can be installed via [homebrew](http://mxcl.github.com/homebrew/) on
7 Mac OS X:
df392683 »
2012-01-15 add imagemagick dependency to contributing guide
8
9 brew install imagemagick
10
a4a0034b »
2013-01-16 Add Vagrant configuration.
11 If you prefer, you can use a [Vagrant](http://www.vagrantup.com/) virtual
12 machine. The Vagrantfile in the capybara-webkit repository will get you up and
13 running with all the development dependencies:
14
15 gem install vagrant
16 vagrant up
17 vagrant ssh
18 cd /vagrant
19 rake
20
21 ## Contributing
df392683 »
2012-01-15 add imagemagick dependency to contributing guide
22
1f46f269 »
2011-07-22 Better formatting for the contribution guide
23 1. Fork the repo.
3e9527a4 »
2011-07-22 a contributing guide
24
1f46f269 »
2011-07-22 Better formatting for the contribution guide
25 2. Run the tests. We only take pull requests with passing tests, and it's great
7fe06e96 »
2012-01-03 Recommend using "bundle exec" just in case
26 to know that you have a clean slate: `bundle && bundle exec rake`
3e9527a4 »
2011-07-22 a contributing guide
27
1f46f269 »
2011-07-22 Better formatting for the contribution guide
28 3. Add a test for your change. Only refactoring and documentation changes
3e9527a4 »
2011-07-22 a contributing guide
29 require no new tests. If you are adding functionality or fixing a bug, we need
30 a test!
31
1f46f269 »
2011-07-22 Better formatting for the contribution guide
32 4. Make the test pass.
3e9527a4 »
2011-07-22 a contributing guide
33
1f46f269 »
2011-07-22 Better formatting for the contribution guide
34 5. Push to your fork and submit a pull request.
3e9527a4 »
2011-07-22 a contributing guide
35
36
37 At this point you're waiting on us. We like to at least comment on, if not
38 accept, pull requests within three business days (and, typically, one business
39 day). We may suggest some changes or improvements or alternatives.
40
41 Some things that will increase the chance that your pull request is accepted,
42 taken straight from the Ruby on Rails guide:
43
44 * Use Rails idioms and helpers
45 * Include tests that fail without your code, and pass with it
46 * Update the documentation, the surrounding one, examples elsewhere, guides,
47 whatever is affected by your contribution
48
49 Syntax:
50
51 * Two spaces, no tabs.
52 * No trailing whitespace. Blank lines should not have any space.
53 * Prefer &&/|| over and/or.
54 * MyClass.my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
55 * a = b and not a=b.
56 * Follow the conventions you see used in the source already.
57
58 And in case we didn't emphasize it enough: we love tests!
Something went wrong with that request. Please try again.