akki commented on a change in pull request #58: HDDS-2293. Create a new CONTRIBUTION.md for the new repository URL: https://github.com/apache/hadoop-ozone/pull/58#discussion_r340240750
########## File path: CONTRIBUTION.md ########## @@ -0,0 +1,176 @@ +Apache Hadoop Ozone Contribution guideline +=== + +Ozone is a part of the Apache Hadoop project. The bug tracking system for Ozone is under the [Apache Jira project named HDDS](https://issues.apache.org/jira/projects/HDDS/). + +If you are familiar with contributing to Apache Hadoop, then you already know everything you need to know to start filing Ozone bugs and submitting patches. + +If you have never contributed to Apache Hadoop before, then you may find it useful to read [How To Contribute](https://cwiki.apache.org/confluence/display/HADOOP/How+To+Contribute+to+Ozone). + +This document summarize the contribution process and defines the differences. + +## What can I contribute? + +We welcome contributions of: + + * **Code**. File a bug and submit a patch, or pick up any one of the unassigned Jiras. + * [Newbie Ozone jiras](https://s.apache.org/OzoneNewbieJiras) + * [All open and unassigned Ozone jiras](https://s.apache.org/OzoneUnassignedJiras) + * **Documentation Improvements**: You can submit improvements to either: + * Ozone website. Instructions are here: [Modifying the Ozone Website](https://cwiki.apache.org/confluence/display/HADOOP/Modifying+the+Ozone+Website) + * Developer docs. These are markdown files [checked into the Apache Hadoop Source tree](https://github.com/apache/hadoop-ozone/tree/master/hadoop-hdds/docs/content). + * The [wiki pages](https://cwiki.apache.org/confluence/display/HADOOP/Ozone+Contributor+Guide): Please contact us at hdfs-dev@hadoop.apache.org and we can provide you write access to the wiki. + * **Testing**: We always need help to improve our testing + * Unit Tests (JUnit / Java) + * Acceptance Tests (docker + robot framework) + * Blockade tests (python + blockade) + * Performance: We have multiple type of load generator / benchmark tools (`ozone freon`, `ozone genesis`), which can be used to test cluster and report problems. + * **Bug reports** pointing out broken functionality, docs, or suggestions for improvements are always welcome! + +## Who To Contact + +If you have any questions, please don't hesitate to contact + + * **email**: use hdfs-dev@hadoop.apache.org. + * **chat**: You can find the #ozone channel at the ASF slack. Invite link is [here](http://s.apache.org/slack-invite) + * **meeting**: [We have weekly meetings](https://cwiki.apache.org/confluence/display/HADOOP/Ozone+Community+Calls) which is open to anybody. Feel free to join and ask any questions + +## Building from the source code + +### Requirements + +Requirements to compile the code: + +* Unix System +* JDK 1.8 +* Maven 3.5 or later +* Protocol Buffers 2.5 +* Internet connection for first build (to fetch all Maven and Hadoop dependencies) + +Additional requirements to run your first pseudo cluster: + +* docker +* docker-compose + +Additional requirements to execute different type of tests: + +* [Robot framework](https://robotframework.org/) (for executing acceptance tests) +* docker-compose (to start pseudo cluster, also used for blockade and acceptance tests) +* [blockade](https://pypi.org/project/blockade/) To execute network fault-injection testing. + +Optional dependencies: + +* [hugo](https://gohugo.io/) to include the documentation in the web ui. + +### Build the project + +The build is as simple as: + +``` +mvn clean install -DskipTests Review comment: This resulted in the following error for me. Is there any other step I need to do? ``` Downloaded from central: https://repo.maven.apache.org/maven2/com/fasterxml/jackson/core/jackson-databind/2.9.5/jackson-databind-2.9.5.jar (1.3 MB at 459 kB/s) [WARNING] [protoc, --version] failed: java.io.IOException: Cannot run program "protoc": error=2, No such file or directory [ERROR] stdout: [] [INFO] ------------------------------------------------------------------------ [INFO] Reactor Summary for Apache Hadoop Ozone Main 0.5.0-SNAPSHOT: [INFO] [INFO] Apache Hadoop Ozone Main ........................... SUCCESS [01:43 min] [INFO] Apache Hadoop HDDS ................................. SUCCESS [13:17 min] [INFO] Apache Hadoop HDDS Config .......................... SUCCESS [01:57 min] [INFO] Apache Hadoop HDDS Common .......................... FAILURE [04:26 min] [INFO] Apache Hadoop HDDS Client .......................... SKIPPED [INFO] Apache Hadoop HDDS Server Framework ................ SKIPPED [INFO] Apache Hadoop HDDS Container Service ............... SKIPPED [INFO] Apache Hadoop HDDS/Ozone Documentation ............. SKIPPED [INFO] Apache Hadoop HDDS SCM Server ...................... SKIPPED [INFO] Apache Hadoop HDDS Tools ........................... SKIPPED [INFO] Apache Hadoop Ozone ................................ SKIPPED [INFO] Apache Hadoop Ozone Common ......................... SKIPPED [INFO] Apache Hadoop Ozone Client ......................... SKIPPED [INFO] Apache Hadoop Ozone Manager Server ................. SKIPPED [INFO] Apache Hadoop Ozone S3 Gateway ..................... SKIPPED [INFO] Apache Hadoop Ozone CSI service .................... SKIPPED [INFO] Apache Hadoop Ozone Recon CodeGen .................. SKIPPED [INFO] Apache Hadoop Ozone Recon .......................... SKIPPED [INFO] Apache Hadoop Ozone Integration Tests .............. SKIPPED [INFO] Apache Hadoop Ozone FileSystem ..................... SKIPPED [INFO] Apache Hadoop Ozone Tools .......................... SKIPPED [INFO] Apache Hadoop Ozone Datanode ....................... SKIPPED [INFO] Apache Hadoop Ozone In-Place Upgrade ............... SKIPPED [INFO] Apache Hadoop Ozone Insight Tool ................... SKIPPED [INFO] Apache Hadoop Ozone FileSystem Single Jar Library .. SKIPPED [INFO] Apache Hadoop Ozone FileSystem Legacy Jar Library .. SKIPPED [INFO] Apache Hadoop Ozone Distribution ................... SKIPPED [INFO] Apache Hadoop Ozone Fault Injection Tests .......... SKIPPED [INFO] Apache Hadoop Ozone Network Tests .................. SKIPPED [INFO] ------------------------------------------------------------------------ [INFO] BUILD FAILURE [INFO] ------------------------------------------------------------------------ [INFO] Total time: 24:22 min [INFO] Finished at: 2019-10-30T00:52:48+07:00 [INFO] ------------------------------------------------------------------------ [ERROR] Failed to execute goal org.apache.hadoop:hadoop-maven-plugins:3.2.0:protoc (compile-protoc) on project hadoop-hdds-common: org.apache.maven.plugin.MojoExecutionException: 'protoc --version' did not return a version -> [Help 1] [ERROR] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch. [ERROR] Re-run Maven using the -X switch to enable full debug logging. [ERROR] [ERROR] For more information about the errors and possible solutions, please read the following articles: [ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException [ERROR] [ERROR] After correcting the problems, you can resume the build with the command [ERROR] mvn <args> -rf :hadoop-hdds-common ``` FWIW Java11 & Maven3.6.2 ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: hdfs-dev-unsubscr...@hadoop.apache.org For additional commands, e-mail: hdfs-dev-h...@hadoop.apache.org
