Skip to content

Commit 7fa0be4

Browse files
committed
fix #410 - add explanation of branches
(cherry picked from commit 06dfc00)
1 parent d9179ee commit 7fa0be4

File tree

2 files changed

+24
-8
lines changed

2 files changed

+24
-8
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,21 @@ at least one of the project maintainers before you start coding.
6262
Nothing is more frustrating than seeing your hard work go to waste because
6363
your vision does not align with that of a project maintainer.
6464

65+
#### Choose the appropriate branch
66+
67+
While the \*master branches reflect the latest released code for the
68+
corresponding server release, the \*develop branches reflect the latest changes
69+
that will be released next and are therefore the right place to commit changes.
70+
To be clear, the following branches have the assigned meaning:
71+
* develop - the place to make changes for the next release
72+
* master - the stable code from the last release
73+
* 3.0-develop - the place to make changes for the next 3.x release (corresponds with the next server 8.x release)
74+
* 3.0-master - the stable code from the last 3.x release (corresponds with the latest server 8.x release)
75+
* 2.0-develop - the place to make changes for the next 2.x release (corresponds with the next server 7.x release)
76+
* 2.0-master - the stable code from the last 2.x release (corresponds with the latest server 7.x release)
77+
* 1.0-develop - the place to make changes for the next 1.x release (corresponds with the next server 6.x release)
78+
* 1.0-master - the stable code from the last 1.x release (corresponds with the latest server 6.x release)
79+
6580
#### Create a branch for your changes
6681

6782
Okay, so you have decided to fix something. Create a feature branch
@@ -161,7 +176,7 @@ local shell as follows:
161176

162177
$ git branch -D my-feature-branch
163178

164-
* Update your dev with the latest upstream version:
179+
* Update your *develop* with the latest upstream version:
165180

166-
$ git pull --ff upstream dev
167-
[issue tracker]: https://github.com/marklogic/java-client-api/issues
181+
$ git pull --ff upstream develop
182+
[issue tracker]: https://github.com/marklogic/java-client-api/issues

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,13 @@ To use the API in your maven project, include the following in your pom.xml:
5151
<dependency>
5252
<groupId>com.marklogic</groupId>
5353
<artifactId>java-client-api</artifactId>
54-
<version>3.0.1</version>
54+
<version>3.0.5</version>
5555
</dependency>
5656

5757
For gradle projects, include the following:
5858

5959
dependencies {
60-
compile group: 'com.marklogic', name: 'java-client-api', version: '3.0.1'
60+
compile group: 'com.marklogic', name: 'java-client-api', version: '3.0.5'
6161
}
6262

6363
Read [The Java API in Five Minutes](http://developer.marklogic.com/try/java/index)
@@ -82,22 +82,23 @@ https://developer.marklogic.com/free-developer
8282

8383
To obtain verified downloads signed with MarkLogic's PGP key, use maven tools or directly download
8484
the .jar and .asc files from
85-
[maven central](http://repo1.maven.org/maven2/com/marklogic/java-client-api/3.0.1/). MarkLogic's
85+
[maven central](http://repo1.maven.org/maven2/com/marklogic/java-client-api/3.0.5/). MarkLogic's
8686
pgp key ID is 48D4B86E and it is available from pgp.mit.edu by installing gnupg and running the command:
8787

8888
$ gpg --keyserver pgp.mit.edu --recv-key 48D4B86E
8989

9090
Files can be verified with the command:
9191

92-
$ gpg java-client-api-3.0.1.jar.asc
92+
$ gpg java-client-api-3.0.5.jar.asc
9393

9494

9595
### Building and Contributing
9696

9797
You can build the API in the same way as any Maven project on git:
9898

9999
1. Clone the java-client-api repository on your machine.
100-
2. Execute a Maven build in the directory containing the pom.xml file.
100+
2. Choose the appropriate branch (usually develop)
101+
3. Execute a Maven build in the directory containing the pom.xml file.
101102

102103
You might want to skip the tests until you have configured a test database and REST server:
103104

0 commit comments

Comments
 (0)