Skip to content

Commit 663b948

Browse files
Bouncheckavelanarius
authored andcommitted
Update .md docs
Adds info about channels to reach out through, how to run tests against scylla. Resolves #130
1 parent f887767 commit 663b948

File tree

2 files changed

+24
-12
lines changed

2 files changed

+24
-12
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,12 @@ imports in ASCII sort order. In addition, please avoid using wildcard imports.
2222

2323
## Working on an issue
2424

25-
Before starting to work on something, please comment in JIRA or ask on the mailing list
26-
to make sure nobody else is working on it.
25+
We use [github issues](https://github.com/scylladb/java-driver/issues) to track ongoing issues.
26+
Before starting to work on something, please check the issues list to make sure nobody else is working on it.
27+
It's also a good idea to get in contact through [ScyllaDB-Users Slack](https://scylladb-users.slack.com/)
28+
to make your intentions known and clear.
2729

28-
If your fix applies to multiple branches, base your work on the lowest active branch. Since version 3 of the driver,
30+
If your fix applies to multiple branches, base your work on the lowest active branch. Most of the time if you want to implement a feature for driver version 3, then you'll base your work on `scylla-3.x` (and `scylla-4.x` for version 4). Since version 3 of the driver,
2931
we've adopted [semantic versioning](http://semver.org/) and our branches use the following scheme:
3032

3133
```
@@ -59,15 +61,13 @@ Before you send your pull request, make sure that:
5961

6062
- you have a unit test that failed before the fix and succeeds after.
6163
- the fix is mentioned in `changelog/README.md`.
62-
- the commit message include the reference of the JIRA ticket for automatic linking
63-
(example: `JAVA-503: Fix NPE when a connection fails during pool construction.`).
64+
- the commit message includes the reference of the github issue for
65+
<a href="https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue">automatic linking</a>
66+
(example: `Fixes #1234`).
6467

6568
As long as your pull request is not merged, it's OK to rebase your branch and push with
66-
`--force`.
67-
68-
If you want to contribute but don't have a specific issue in mind, the [lhf](https://datastax-oss.atlassian.net/secure/IssueNavigator.jspa?reset=true&mode=hide&jqlQuery=project%20%3D%20JAVA%20AND%20status%20in%20(Open%2C%20Reopened)%20AND%20labels%20%3D%20lhf)
69-
label in JIRA is a good place to start: it marks "low hanging fruits" that don't require
70-
in-depth knowledge of the codebase.
69+
`--force`. Commit history should be as flat as reasonably possible. Multiple commits where each one represents a single logical piece of pull request are fine.
70+
If you want to contribute but don't have a specific issue in mind, it's best to reach out through users slack.
7171

7272
## Editor configuration
7373

@@ -91,14 +91,26 @@ mvn test -Pshort
9191

9292
The default is "unit". Each profile runs only their own category ("short" will *not* run "unit").
9393

94-
Integration tests use [CCM](https://github.com/pcmanus/ccm) to bootstrap Cassandra instances.
94+
Integration tests use [CCM](https://github.com/pcmanus/ccm) to bootstrap Cassandra instances. It is recommended to
95+
setup [Scylla CCM](https://github.com/scylladb/scylla-ccm) in its place:
96+
```
97+
pip3 install https://github.com/scylladb/scylla-ccm/archive/master.zip
98+
```
99+
95100
Two Maven properties control its execution:
96101

97102
- `cassandra.version`: the Cassandra version. This has a default value in the root POM,
98103
you can override it on the command line (`-Dcassandra.version=...`).
99104
- `ipprefix`: the prefix of the IP addresses that the Cassandra instances will bind to (see
100105
below). This defaults to `127.0.1.`.
101106

107+
Additionally `-Dscylla.version=${{ matrix.scylla-version }}` can be used instead with Scylla CCM to test against Scylla.
108+
109+
Examples:
110+
- `mvn test -Pshort -Dcassandra.version=3.11.11`
111+
- `mvn test -Plong -Dcassandra.version=3.11.11`
112+
- `mvn verify -Plong -Dscylla.version=4.3.6`
113+
102114

103115
CCM launches multiple Cassandra instances on localhost by binding to different addresses. The
104116
driver uses up to 10 different instances (127.0.1.1 to 127.0.1.10 with the default prefix).

testing/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Install CCM
44

5-
pip install ccm
5+
pip3 install https://github.com/scylladb/scylla-ccm/archive/master.zip
66

77
### Setup CCM Loopbacks (required for OSX)
88

0 commit comments

Comments
 (0)