You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+23-11Lines changed: 23 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,10 +22,12 @@ imports in ASCII sort order. In addition, please avoid using wildcard imports.
22
22
23
23
## Working on an issue
24
24
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.
27
29
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,
29
31
we've adopted [semantic versioning](http://semver.org/) and our branches use the following scheme:
30
32
31
33
```
@@ -59,15 +61,13 @@ Before you send your pull request, make sure that:
59
61
60
62
- you have a unit test that failed before the fix and succeeds after.
61
63
- 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
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.
71
71
72
72
## Editor configuration
73
73
@@ -91,14 +91,26 @@ mvn test -Pshort
91
91
92
92
The default is "unit". Each profile runs only their own category ("short" will *not* run "unit").
93
93
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:
0 commit comments