2012-11-06 18:41:09 -05:00
|
|
|
## Questions about Capybara?
|
2012-09-21 10:52:41 -04:00
|
|
|
|
2012-11-06 18:41:09 -05:00
|
|
|
To get your questions answered, please ask on the [mailing list]. Do not open
|
|
|
|
|
an issue.
|
2012-09-21 10:52:41 -04:00
|
|
|
|
2012-11-06 18:41:09 -05:00
|
|
|
## Bug Reports
|
2012-09-21 10:52:41 -04:00
|
|
|
|
2012-11-06 18:41:09 -05:00
|
|
|
If you are at all unsure whether it's a bug in Capybara or a problem with your
|
|
|
|
|
code, post on the [mailing list] instead. If it turns out that it is a bug, we
|
|
|
|
|
can always open an issue later.
|
2012-09-21 10:52:41 -04:00
|
|
|
|
2012-11-06 18:41:09 -05:00
|
|
|
If you are sure that it's a bug in Capybara, open a new [issue] and try to
|
|
|
|
|
answer the following questions:
|
2012-09-21 10:57:18 -04:00
|
|
|
|
|
|
|
|
- What did you do?
|
|
|
|
|
- What did you expect to happen?
|
|
|
|
|
- What happened instead?
|
|
|
|
|
|
2012-11-06 18:41:09 -05:00
|
|
|
Please also post code to replicate the bug. Ideally a failing test would be
|
2013-06-28 07:08:25 -04:00
|
|
|
perfect, but even a simple script demonstrating the error would suffice. You
|
|
|
|
|
could use [this template](https://gist.github.com/jnicklas/5137053) as a
|
|
|
|
|
starting point. Please don't send us an entire application, unless the bug is
|
|
|
|
|
in the *interaction* between Capybara and a particular framework.
|
2012-09-21 10:52:41 -04:00
|
|
|
|
2013-02-28 04:01:34 -05:00
|
|
|
Make sure to specify which version of Capybara you are using.
|
|
|
|
|
|
2012-09-21 10:52:41 -04:00
|
|
|
Feature requests are great, but they usually end up lying around the issue
|
|
|
|
|
tracker indefinitely. Sending a pull request is a much better way of getting a
|
2012-11-06 18:41:09 -05:00
|
|
|
particular feature into Capybara.
|
2012-09-21 10:52:41 -04:00
|
|
|
|
2012-11-06 18:41:09 -05:00
|
|
|
## Pull Requests
|
2012-09-21 10:52:41 -04:00
|
|
|
|
2012-09-21 10:57:18 -04:00
|
|
|
- **Add tests!** Your patch won't be accepted if it doesn't have tests.
|
2012-09-21 10:52:41 -04:00
|
|
|
|
2012-09-21 10:57:18 -04:00
|
|
|
- **Document any change in behaviour**. Make sure the README and any other
|
2012-09-21 10:52:41 -04:00
|
|
|
relevant documentation are kept up-to-date.
|
|
|
|
|
|
2012-09-21 10:57:18 -04:00
|
|
|
- **Consider our release cycle**. We try to follow semver. Randomly breaking
|
2012-09-21 10:52:41 -04:00
|
|
|
public APIs is not an option.
|
|
|
|
|
|
2012-09-21 10:57:18 -04:00
|
|
|
- **Create topic branches**. Don't ask us to pull from your master branch.
|
2012-09-21 10:52:41 -04:00
|
|
|
|
2012-09-21 10:57:18 -04:00
|
|
|
- **One pull request per feature**. If you want to do more than one thing, send
|
2012-09-21 10:52:41 -04:00
|
|
|
multiple pull requests.
|
|
|
|
|
|
2012-09-21 10:57:18 -04:00
|
|
|
- **Send coherent history**. Make sure each individual commit in your pull
|
2012-09-21 10:52:41 -04:00
|
|
|
request is meaningful. If you had to make multiple intermediate commits while
|
|
|
|
|
developing, please squash them before sending them to us.
|
|
|
|
|
|
2012-11-06 18:41:09 -05:00
|
|
|
[mailing list]: http://groups.google.com/group/ruby-capybara
|
|
|
|
|
[issue]: https://github.com/jnicklas/capybara/issues
|
