kotovalexarian-likes-github/capybara-webkit
1
0
Fork 0
mirror of https://github.com/thoughtbot/capybara-webkit synced 2023-03-27 23:22:28 -04:00
Code Releases Activity
capybara-webkit/CONTRIBUTING.md

62 lines
2 KiB
Markdown
Raw Normal View History

Link to thoughtbot's contributor code of conduct
2015-04-09 16:51:08 -04:00
We love pull requests from everyone. We expect users to follow our
[code of conduct] while submitting code or comments.
[code of conduct]: https://thoughtbot.com/open-source-code-of-conduct
a contributing guide
2011-07-22 16:59:13 -04:00
Add Vagrant configuration. capybara-webkit has various development dependencies which can be a little cumbersome to manage. With vagrant they can all be nicely bundled up in a VM and installed automatically.
2013-01-16 17:05:58 -05:00
## Dependencies
add imagemagick dependency to contributing guide Several tests in driver_rendering_spec.rb require the identify command that is part of Imagemagick. Without it they fail with output similar to the following. MiniMagick::Error: Command ("identify -ping /var/folders/y3/vfvjgwm91f1fmt2syh21czx40000gn/T/mini_magick20120115-49056-pwh5nl-0.png") failed: {:output=>"sh: identify: command not found\n", :status_code=>127}
2012-01-15 18:49:44 -05:00
Some of the tests depend on the `identify` command that comes with Imagemagick.
Add Vagrant configuration. capybara-webkit has various development dependencies which can be a little cumbersome to manage. With vagrant they can all be nicely bundled up in a VM and installed automatically.
2013-01-16 17:05:58 -05:00
Imagemagick can be installed via [homebrew](http://mxcl.github.com/homebrew/) on
Mac OS X:
add imagemagick dependency to contributing guide Several tests in driver_rendering_spec.rb require the identify command that is part of Imagemagick. Without it they fail with output similar to the following. MiniMagick::Error: Command ("identify -ping /var/folders/y3/vfvjgwm91f1fmt2syh21czx40000gn/T/mini_magick20120115-49056-pwh5nl-0.png") failed: {:output=>"sh: identify: command not found\n", :status_code=>127}
2012-01-15 18:49:44 -05:00
brew install imagemagick
Add Vagrant configuration. capybara-webkit has various development dependencies which can be a little cumbersome to manage. With vagrant they can all be nicely bundled up in a VM and installed automatically.
2013-01-16 17:05:58 -05:00
If you prefer, you can use a [Vagrant](http://www.vagrantup.com/) virtual
machine. The Vagrantfile in the capybara-webkit repository will get you up and
running with all the development dependencies:
gem install vagrant
vagrant up
vagrant ssh
cd /vagrant
rake
## Contributing
add imagemagick dependency to contributing guide Several tests in driver_rendering_spec.rb require the identify command that is part of Imagemagick. Without it they fail with output similar to the following. MiniMagick::Error: Command ("identify -ping /var/folders/y3/vfvjgwm91f1fmt2syh21czx40000gn/T/mini_magick20120115-49056-pwh5nl-0.png") failed: {:output=>"sh: identify: command not found\n", :status_code=>127}
2012-01-15 18:49:44 -05:00
Better formatting for the contribution guide
2011-07-22 17:02:28 -04:00
1. Fork the repo.
a contributing guide
2011-07-22 16:59:13 -04:00
Better formatting for the contribution guide
2011-07-22 17:02:28 -04:00
2. Run the tests. We only take pull requests with passing tests, and it's great
Recommend using "bundle exec" just in case This avoids issues like this one: https://github.com/jnicklas/capybara/issues/585
2012-01-03 07:49:48 -05:00
to know that you have a clean slate: `bundle && bundle exec rake`
a contributing guide
2011-07-22 16:59:13 -04:00
Better formatting for the contribution guide
2011-07-22 17:02:28 -04:00
3. Add a test for your change. Only refactoring and documentation changes
a contributing guide
2011-07-22 16:59:13 -04:00
require no new tests. If you are adding functionality or fixing a bug, we need
a test!
Better formatting for the contribution guide
2011-07-22 17:02:28 -04:00
4. Make the test pass.
a contributing guide
2011-07-22 16:59:13 -04:00
Better formatting for the contribution guide
2011-07-22 17:02:28 -04:00
5. Push to your fork and submit a pull request.
a contributing guide
2011-07-22 16:59:13 -04:00
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
day). We may suggest some changes or improvements or alternatives.
Some things that will increase the chance that your pull request is accepted,
taken straight from the Ruby on Rails guide:
* Use Rails idioms and helpers
* Include tests that fail without your code, and pass with it
* Update the documentation, the surrounding one, examples elsewhere, guides,
whatever is affected by your contribution
Syntax:
* Two spaces, no tabs.
* 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.
* Follow the conventions you see used in the source already.
And in case we didn't emphasize it enough: we love tests!
Copy permalink