Skip to content

Commit 0c9ae16

Browse files
committed
Update contribution guidelines.
1 parent 6ecd46c commit 0c9ae16

4 files changed

Lines changed: 5 additions & 346 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
Before starting to work on something, please comment in JIRA or ask on the mailing list
66
to make sure nobody else is working on it.
77

8-
If a fix applies to 2.1 and 3.0, work on the 2.1 branch, your commit will eventually
9-
get merged in 3.0. Other branches (2.0 and 2.2) are now discontinued.
8+
If your fix applies to multiple branches, base your work on the lowest active branch
9+
(2.1 at the time of writing, but ask for confirmation). We regularly merge changes downstream.
1010

1111
Before you send your pull request, make sure that:
1212

@@ -24,46 +24,8 @@ in-depth knowledge of the codebase.
2424

2525
## Editor configuration
2626

27-
### General
28-
29-
We consider automatic formatting as a help, not a crutch. Sometimes it makes sense to
30-
break the rules to make the code more readable, for instance aligning columns (see the
31-
constant declarations in `DataType.Name` for an example of this).
32-
33-
**Please do not reformat whole files, only the lines that you have added or modified**.
34-
35-
36-
### Eclipse
37-
38-
Formatter:
39-
40-
- Preferences > Java > Code Style > Formatter.
41-
- Click "Import".
42-
- Select `src/main/config/ide/eclipse-formatter.xml`.
43-
44-
Import order:
45-
46-
- Preferences > Java > Code Style > Organize imports.
47-
- Click "Import".
48-
- Select `src/main/config/ide/eclipse.importorder`.
49-
50-
Prevent trailing whitespaces:
51-
52-
- Preferences > Java > Editor > Save Actions.
53-
- Check "Perform the selected actions on save".
54-
- Ensure "Format source code" and "Organize imports" are unchecked.
55-
- Check "Additional actions".
56-
- Click "Configure".
57-
- In the "Code Organizing" tab, check "Remove trailing whitespace" and "All lines".
58-
- Click "OK" (the text area should only have one action "Remove trailing white spaces").
59-
60-
61-
### IntelliJ IDEA
62-
63-
- File > Import Settings...
64-
- Select `src/main/config/ide/intellij-code-style.jar`.
65-
66-
This should add a new Code Style scheme called "java-driver".
27+
We use IntelliJ IDEA with the default formatting options. Please format your code and
28+
organize imports before submitting your changes.
6729

6830
## Running the tests
6931

@@ -90,7 +52,7 @@ Two Maven properties control its execution:
9052

9153

9254
CCM launches multiple Cassandra instances on localhost by binding to different addresses. The
93-
driver uses up to 6 different instances (127.0.1.1 to 127.0.1.6 with the default prefix).
55+
driver uses up to 10 different instances (127.0.1.1 to 127.0.1.10 with the default prefix).
9456
You'll need to define loopback aliases for this to work, on Mac OS X your can do it with:
9557

9658
```

0 commit comments

Comments
 (0)