From 67b5dfd9f822de73e2005ea1640e01e78549a65f Mon Sep 17 00:00:00 2001 From: Dave Cassel Date: Fri, 17 Jul 2020 10:27:34 -0400 Subject: [PATCH] Updating JDK and config references --- CONTRIBUTING.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 039ef280a..a0bddbbc2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,8 @@ +# Getting Started + Here's how to get started with making contributions to this project: -1. Install a JDK (Java Development Kit) version 7 or higher. +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.) 1. Clone this repository. 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. 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 there are many automated tests. I also haven't found an easy way to test tasks or the MarkLogicPlugin class. So for the time being, don't worry about automated tests. -I also don't have an .editorconfig file yet. In the absence of one, just follow these simple guidelines: +## Formatting -1. Use spaces for tabs -1. Use a tab size of 4 spaces +See the [.editorconfig](.editorconfig) file. If you don't have an [editorconfig plugin](https://editorconfig.org/#download), +either install that or follow the guidelines set in the file. ## How to test ml-gradle changes