Skip to content

Updating JDK and config references #559

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 17, 2020
Merged

Updating JDK and config references #559

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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

Expand Down