fluo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ktur...@apache.org
Subject [fluo-recipes] branch master updated: Added CONTRIBUTING.md (#143)
Date Thu, 28 Sep 2017 14:28:54 GMT
This is an automated email from the ASF dual-hosted git repository.

kturner pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/fluo-recipes.git


The following commit(s) were added to refs/heads/master by this push:
     new 2844a7a  Added CONTRIBUTING.md (#143)
2844a7a is described below

commit 2844a7ad24c154716f442b9323b1031c0c4eae61
Author: Keith Turner <keith@deenlo.com>
AuthorDate: Thu Sep 28 10:28:52 2017 -0400

    Added CONTRIBUTING.md (#143)
---
 CONTRIBUTING.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..522e539
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -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/

-- 
To stop receiving notification emails like this one, please contact
['"commits@fluo.apache.org" <commits@fluo.apache.org>'].

Mime
View raw message