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
+37-16Lines changed: 37 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ Looking to build the code from source? Look no further.
24
24
You need these to get started
25
25
26
26
- Java 8 JDK
27
-
- Gradle (the newer the better)
27
+
- Gradle (3.1 or greater)
28
28
- Node JS 6.5 or newer
29
29
- Typings `npm -g install typings`
30
30
- A decent IDE. IntelliJ is nice.
@@ -36,29 +36,46 @@ To build the entire DHF (marklogic-data-hub.jar, quickstart.war, and ml-data-hub
36
36
37
37
```bash
38
38
cd /path/to/data-hub-project/
39
-
gradle build -x test
39
+
./gradlew build -x test
40
40
```
41
41
42
-
#### Running your local hub instead of the cloud hosted one
42
+
#### Making Changes to the Hub Gradle Plugin
43
+
44
+
This is for when you are making changes to the ml-data-hub-plugin. This is a gradle plugin that enables Hub Capabilities. Most likely you won't find yourself doing this. You can safely ignore this section.
45
+
46
+
Still here? Seems you really want to modify the Gradle Plugin. Here's how to tell Gradle to use your local copy instead of the one living up on the Cloud.
47
+
43
48
```bash
44
49
cd /path/to/data-hub-project/
45
-
gradle publishToMavenLocal
50
+
./gradlew publishToMavenLocal
46
51
cd /path/to/data-hub-project/ml-data-hub-plugin
47
-
gradle publishToMavenLocal
52
+
./gradlew publishToMavenLocal
48
53
```
49
54
50
55
Then in your build.gradle file you will need to use the local version:
51
56
```groovy
57
+
58
+
// this goes at the top above the plugins section
59
+
52
60
buildscript {
53
61
repositories {
54
62
mavenLocal()
55
63
jcenter()
56
64
}
57
65
dependencies {
58
-
classpath "com.marklogic:ml-data-hub-plugin:(the version number you chose)"
66
+
classpath "com.marklogic:ml-data-hub:(the version number you chose)"
59
67
}
60
68
}
61
-
apply plugin: "com.marklogic.ml-data-hub-plugin"
69
+
70
+
plugins {
71
+
...
72
+
73
+
// comment out this line. It pulls the version from the cloud
74
+
// id 'com.marklogic.ml-data-hub' version '2.0.0-alpha.3'
75
+
}
76
+
77
+
// this tells gradle to apply the plugin you included above in the buildscript section
78
+
apply plugin: "com.marklogic.ml-data-hub"
62
79
```
63
80
64
81
#### Running the QuickStart UI from source
@@ -69,7 +86,7 @@ You will need to open two terminal windows.
69
86
**Terminal window 1** - This runs the webapp.
70
87
```bash
71
88
cd /path/to/data-hub-project
72
-
gradle bootrun
89
+
./gradlew bootrun
73
90
```
74
91
75
92
**Terminal window 2** - This runs the Quickstart UI
@@ -112,10 +129,10 @@ your vision does not align with that of a project maintainer.
112
129
#### Create a branch for your changes
113
130
114
131
Okay, so you have decided to fix something. Create a feature branch
115
-
and start hacking. **Note** that we use git flow and thus our most recent changes live on the develop branch.
132
+
and start hacking. **Note** that we use git flow and thus our most recent changes live on the 2.0-develop branch.
@@ -165,7 +182,7 @@ Use `git rebase` (not `git merge`) to sync your work from time to time.
165
182
166
183
```sh
167
184
$ git fetch upstream
168
-
$ git rebase upstream/develop
185
+
$ git rebase upstream/2.0-develop
169
186
```
170
187
171
188
@@ -174,7 +191,7 @@ $ git rebase upstream/develop
174
191
Make sure the JUnit tests pass.
175
192
176
193
```sh
177
-
$ gradletest
194
+
$ ./gradlewtest
178
195
```
179
196
180
197
Make sure that all tests pass. Please, do not submit patches that fail.
@@ -185,6 +202,10 @@ Make sure that all tests pass. Please, do not submit patches that fail.
185
202
$ git push origin my-feature-branch
186
203
```
187
204
205
+
#### Agree to the contributor License
206
+
207
+
Before we can merge your changes, you need to sign a [Contributor License Agreement](http://developer.marklogic.com/products/cla). You only need to do this once.
208
+
188
209
#### Submit the pull request
189
210
190
211
Go to https://github.com/username/marklogic-data-hub and select your feature branch. Click
@@ -209,10 +230,10 @@ from the main (upstream) repository:
209
230
git push origin --delete my-feature-branch
210
231
```
211
232
212
-
* Check out the develop branch:
233
+
* Check out the 2.0-develop branch:
213
234
214
235
```shell
215
-
git checkout develop -f
236
+
git checkout 2.0-develop -f
216
237
```
217
238
218
239
* Delete the local branch:
@@ -221,10 +242,10 @@ from the main (upstream) repository:
221
242
git branch -D my-feature-branch
222
243
```
223
244
224
-
* Update your develop with the latest upstream version:
245
+
* Update your 2.0-develop with the latest upstream version:
This project and its code and functionality is not representative of MarkLogic Server and is not supported by MarkLogic.
4
+
5
+
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
6
+
7
+
http://www.apache.org/licenses/LICENSE-2.0
8
+
9
+
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
0 commit comments