From 3b44b8a005a5d1cf610796705744bbc41fb0434d Mon Sep 17 00:00:00 2001 From: Carmine DiMascio Date: Sun, 14 Feb 2021 22:29:59 -0500 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 333818e..c5e69aa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,28 +2,28 @@ ## Develop -#### 1. Fork this repo +1. Fork this repo -#### 2. Build the project +2. Build the project -```shell -# java >=8 required -export JAVA_HOME=/path/to/java8/home + ```shell + # java >=8 required + export JAVA_HOME=/path/to/java8/home -mvn build -``` + mvn build + ``` -#### 3. Make a change +3. Make a change -fix a bug, add a feature, update the doc, etc + Fix a bug, add a feature, update the doc, etc -#### 4. Run the Tests +4. Run the Tests -```shell -mvn test -``` + ```shell + mvn test + ``` -#### 5. Create a Pull Request (PR) +5. Create a Pull Request (PR) ## Add yourself as a contributor