GEODE-2370: First pass at a CONTRIBUTING document.
Project: http://git-wip-us.apache.org/repos/asf/geode/repo Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/3ade3887 Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/3ade3887 Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/3ade3887 Branch: refs/heads/next-gen-native-client-software-grant Commit: 3ade3887c95051268512210c646a6d56631925cb Parents: 8a8a74a Author: Ernest Burghardt <eburgha...@pivotal.io> Authored: Thu Jan 26 15:21:13 2017 -0800 Committer: Jacob Barrett <jbarr...@pivotal.io> Committed: Mon Jan 30 10:30:35 2017 -0800 ---------------------------------------------------------------------- CONTRIBUTING.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/geode/blob/3ade3887/CONTRIBUTING.md ---------------------------------------------------------------------- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..32d696d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,71 @@ +# Contributing + +## Building the code + see BUILDING.md + +## Gitflow + cd <clone> + git checkout -b feature/<GEODE-jira-number> + +## Formatting C++ + $ cd <clone> + $ mkdir build + $ cd build + $ cmake ../src -DCLANG_FORMAT=<path to clang-format> + $ cmake --build . --target format + +# System Requirements + +## All Platforms + +### Required Tools +* [CMake 4.3](https://cmake.org/) or newer +* C++11 compiler *(see platform specific requirements)* +* [Doxygen 8.11](http://www.stack.nl/~dimitri/doxygen/download.html) *(for building source documentation)* + +## Mac OS X +* Mac OS X 10.12 (Sierra) + +### Required Tools +* [XCode](https://developer.apple.com/xcode/download/) +* Xcode command line developer tools + + `$ xcode-select --install` + +### Optional Tools +* [CMake GUI](https://cmake.org/files/v3.4/cmake-3.4.3-Darwin-x86_64.dmg) +* [Doxygen GUI](http://ftp.stack.nl/pub/users/dimitri/Doxygen-1.8.11.dmg) +* [Eclipse CDT 8.8](https://eclipse.org/cdt/) or newer + +## Windows +* Windows 8.1 64-bit +* Windows 10 64-bit +* Windows Server 2012 64-bit +* Windows Server 2012 R2 64-bit + +### Required Tools +* [Visual Studio 2013](https://www.visualstudio.com) or newer +* [Cygwin](https://www.cygwin.com/) + +## Linux +* RHEL/CentOS 6 +* RHEL/CentOS 7 +* SLES 11 +* SLES 12 + +### Required Tools +* [GCC 4.6](https://gcc.gnu.org) or newer + +### Optional Tools +* [Eclipse CDT 8.8](https://eclipse.org/cdt/) or newer + +## Solaris +* Solaris 10 SPARC +* Solaris 10 x86 +* Solaris 11 SPARC +* Solaris 11 x86 + +### Required Tools +* [Solaris Studio 12.4](http://www.oracle.com/technetwork/server-storage/solarisstudio/downloads/index-jsp-141149.html) or newer + + \ No newline at end of file
