geode-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jbarr...@apache.org
Subject [1/4] geode git commit: GEODE-2370: Added instructions on running tests and link to contributions page.
Date Mon, 30 Jan 2017 18:34:29 GMT
Repository: geode
Updated Branches:
  refs/heads/next-gen-native-client-software-grant 8a8a74aea -> 739034dbe


GEODE-2370: Added instructions on running tests and link to contributions page.


Project: http://git-wip-us.apache.org/repos/asf/geode/repo
Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/fd5ddd25
Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/fd5ddd25
Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/fd5ddd25

Branch: refs/heads/next-gen-native-client-software-grant
Commit: fd5ddd25e64028bc91a9e844987c35fc91a88e52
Parents: 3ade388
Author: Ernest Burghardt <eburghardt@pivotal.io>
Authored: Fri Jan 27 13:26:33 2017 -0800
Committer: Jacob Barrett <jbarrett@pivotal.io>
Committed: Mon Jan 30 10:30:35 2017 -0800

----------------------------------------------------------------------
 CONTRIBUTING.md | 35 +++++++++++++++++++++++++++++++----
 1 file changed, 31 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/geode/blob/fd5ddd25/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 32d696d..65d6a56 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,12 +1,39 @@
 # Contributing
+This document assumes you have followed the [Apache Geode Code contribution instructions](https://cwiki.apache.org/confluence/display/GEODE/Code+contributions)
 
 ## Building the code
     see BUILDING.md
 
-## Gitflow
-    cd <clone>
-    git checkout -b feature/<GEODE-jira-number>
-    
+## Next steps
+* Make your changes/add your feature/fix a bug.
+* Test your feature branch changes
+* Check your formatting
+* Submit a pull request
+
+## Testing
+   Before submitting a pull request the unit and integration tests must all pass.
+### Running unit tests
+    $ cd <clone>
+    $ cd build
+
+   The following steps will be updated once the "run-unit-tests" target is fixed.
+
+    $ cd cppcache/test/<Debug|Release|if needed>
+    $ ./gfcppcache_unittests
+### Running integration tests
+    $ cd <clone>
+    $ cd build
+    $ cmake --build . --target run-integration-tests
+
+   Which is equivalent to running ctest directly:
+
+    $ cd build/cppcache/integration-test
+    $ ctest --timeout 2000 -L STABLE -C <Debug|Release> -R . -j1
+   This will take ~ 2 hours, YMMV... you can up the jobs to 4 and run in parallel, but you
may end up with test failures that will need to be re-run sequentially.  Like so:
+
+    $ cd build/cppcache/integration-test
+    $ ctest -R <test_name> -C <Debug|Release>
+
 ## Formatting C++
     $ cd <clone>
     $ mkdir build


Mime
View raw message