Skip to content

Commit b35e7f6

Browse files
authored
Merge pull request #559 from dmcassel/update-contributing
Updating JDK and config references
2 parents 8a0fdca + 67b5dfd commit b35e7f6

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
# Getting Started
2+
13
Here's how to get started with making contributions to this project:
24

3-
1. Install a JDK (Java Development Kit) version 7 or higher.
5+
1. Install a JDK (Java Development Kit) version 9 or higher. (If you're working with ml-gradle 2.x or 3.x, you only need Java 8.)
46
1. Clone this repository.
57
1. Assuming you want to use Eclipse for development, run "gradlew eclipse" (or "gradle eclipse" if you have Gradle installed locally). This will generate Eclipse project files.
68
1. Import your repository folder as a new project in Eclipse. Everything should compile successfully and you should be good to go.
@@ -16,10 +18,10 @@ Currently, I don't have any tests for ml-gradle, as most of the interesting func
1618
there are many automated tests. I also haven't found an easy way to test tasks or the MarkLogicPlugin class. So for the
1719
time being, don't worry about automated tests.
1820

19-
I also don't have an .editorconfig file yet. In the absence of one, just follow these simple guidelines:
21+
## Formatting
2022

21-
1. Use spaces for tabs
22-
1. Use a tab size of 4 spaces
23+
See the [.editorconfig](.editorconfig) file. If you don't have an [editorconfig plugin](https://editorconfig.org/#download),
24+
either install that or follow the guidelines set in the file.
2325

2426
## How to test ml-gradle changes
2527

0 commit comments

Comments
 (0)