Skip to content
This repository was archived by the owner on Feb 27, 2023. It is now read-only.

Commit 205491d

Browse files
author
Scott Stafford
committed
Add instruction to pull from git lfs when cloning this repository
1 parent 660290e commit 205491d

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,24 @@ Each contributor should be knowledgeable and proficient at the following project
1313
* [MarkLogic JUnit Library](https://github.com/rjrudin/ml-junit)
1414
* [MarkLogic App Deployer](https://github.com/rjrudin/ml-app-deployer)
1515
* [Git](http://git-scm.com/doc)
16+
* [Git Large File System](https://git-lfs.github.com/) - this is required to pull down large binary files used for the Entity Extraction examples
1617

1718
# What software do I need?
1819

1920
* [MarkLogic 8+](http://developer.marklogic.com/products)
2021
* [Java Development Kit 1.8+](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
21-
* [Gradle 3.+](http://gradle.org/gradle-download/)
22+
* (Recommended) [Gradle 3.+](http://gradle.org/gradle-download/)
2223

2324
You will need to first install MarkLogic if you haven't already. It is recommended to use a virtual machine or remote server to run MarkLogic to partition our resources (MarkLogic likes to use a lot of memory).
2425

26+
# Git Large File System
27+
28+
Make sure that after you clone this repository that you also pull from Git LFS. Otherwise your tests may not pass.
29+
2530
# What code baseline should I use?
26-
We use a [fork-and-Branch Git workflow](http://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/). The dev branch contains the latest and greatest code, while master represents the latest published version. **Always branch from DEV**. If you issue a pull request, make sure to compare against the DEV branch.
31+
The dev branch contains the latest and greatest code, while master represents the latest published version. **Always branch from DEV**. If you issue a pull request, make sure to compare against the DEV branch.
32+
33+
We use a [fork-and-Branch Git workflow](http://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/).
2734

2835
# Should I use an IDE?
2936
Yes, it is recommended to use a Java friendly IDE to make one's life easier. Of course, you can use a simple text editor if that is your preference. The lead authors have a recent preference for [IntelliJ](https://www.jetbrains.com/idea/). We also use Gradle for our swiss army knife of building, testing, deploying, etc. One of the cool features of Gradle is the ability to create the project files for two popular IDE's, IntelliJ and Eclipse.

0 commit comments

Comments
 (0)