|
5 | 5 | All code has bugs, but if you report them they can be squashed. |
6 | 6 |
|
7 | 7 | The best bug reports include everything that is needed to reliably reproduce the bug. |
| 8 | + |
| 9 | +### Running the Test Suite |
| 10 | + |
8 | 11 | Try to write a test case and include it in your report (have a look at the |
9 | | -[regression test suite](spec/integration/regression_spec.rb) if you need inspiration). |
10 | | -Submit defect reports to our [Jira](https://datastax-oss.atlassian.net/projects/RUBY/issues). |
| 12 | +[regression test suite](spec/regressions) if you need inspiration). |
| 13 | + |
| 14 | +1. Bundle with `bundle install` |
| 15 | +1. Run the unit test suite with `rake rspec` |
| 16 | + * Using this rake task will install necessary ruby extensions as a prerequisite |
| 17 | + * For `bundle exec rspec` to be successful, run `bundle exec rake compile` once, beforehand |
11 | 18 |
|
12 | 19 | If it's not possible to write a test case, for example because the bug only happens in |
13 | | -very particular circumstances, or is not deterministic, make sure you include as much |
14 | | -information as you can about the situation. The version of the ruby driver is an absolute |
15 | | -must, the version of Ruby and Cassandra are also very important. If there is a stack trace |
16 | | -from the error make sure to include that (unfortunately the asynchronous nature of the |
17 | | -ruby driver means that the stack traces are not always as revealing as they could be). |
| 20 | +very particular circumstances, or is not deterministic, please still report the bug! |
| 21 | + |
| 22 | +### Opening a ticket |
| 23 | + |
| 24 | +Submit defect reports to our [Jira](https://datastax-oss.atlassian.net/projects/RUBY/issues). Include: |
| 25 | + |
| 26 | +* The `cassandra-driver` version (`bundle exec gem cassandra-driver -v`) |
| 27 | +* The Ruby version (`ruby -v`) |
| 28 | +* The Cassandra version (2nd line printed when running `cqlsh`) |
| 29 | +* A stack trace from the error, if there is one |
18 | 30 |
|
19 | | -##Pull Requests |
| 31 | +## Pull Requests |
20 | 32 |
|
21 | 33 | If you're able to fix a bug yourself, you can |
22 | 34 | [fork the repository](https://help.github.com/articles/fork-a-repo/) and submit a |
|
0 commit comments