Added CONTRIBUTING.md (#143)
authorKeith Turner <keith@deenlo.com>
Thu, 28 Sep 2017 14:28:52 +0000 (10:28 -0400)
committerGitHub <noreply@github.com>
Thu, 28 Sep 2017 14:28:52 +0000 (10:28 -0400)
CONTRIBUTING.md [new file with mode: 0644]

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..522e539
--- /dev/null
@@ -0,0 +1,49 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+# Contributing to Fluo Recipes
+
+## Building Fluo Recipes
+
+If you have [Git], [Maven], and [Java][java] (version 8+) installed, run these commands to build
+Fluo:
+
+    git clone https://github.com/apache/fluo-recipes.git
+    cd fluo-recipes
+    mvn package
+
+## Testing Fluo Recipes
+
+Fluo has a test suite that consists of the following:
+
+*  Units tests which are run by `mvn package`
+*  Integration tests which are run using `mvn verify`. These tests start a local Fluo instance
+   (called MiniFluo) and run against it.
+
+## Pull Request
+
+Before making a pull request please attempt to run `mvn verify`.  If it fails and you are not sure 
+why, it's OK to go ahead and make the pull request.
+
+## See Also
+
+* [How to Contribute][contribute] on Apache Fluo project website
+
+[Git]: https://git-scm.com/
+[java]: http://openjdk.java.net/
+[Maven]: https://maven.apache.org/
+[contribute]: https://fluo.apache.org/how-to-contribute/