You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@phoenix.apache.org by gr...@apache.org on 2014/06/03 22:18:52 UTC
svn commit: r1599783 - /phoenix/site/publish/contributing.html
Author: greid
Date: Tue Jun 3 20:18:52 2014
New Revision: 1599783
URL: http://svn.apache.org/r1599783
Log:
Add rendered contributing.html
Added:
phoenix/site/publish/contributing.html
Added: phoenix/site/publish/contributing.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/contributing.html?rev=1599783&view=auto
==============================================================================
--- phoenix/site/publish/contributing.html (added)
+++ phoenix/site/publish/contributing.html Tue Jun 3 20:18:52 2014
@@ -0,0 +1,413 @@
+
+<!DOCTYPE html>
+<!--
+ Generated by Apache Maven Doxia at 2014-06-03
+ Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
+-->
+<html xml:lang="en" lang="en">
+
+ <head>
+ <meta charset="UTF-8" />
+ <title>Contributing | Apache Phoenix</title>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="description" content="" />
+ <meta http-equiv="content-language" content="en" />
+
+ <link href="http://netdna.bootstrapcdn.com/bootswatch/2.3.2/united/bootstrap.min.css" rel="stylesheet" />
+ <link href="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.1/css/bootstrap-responsive.min.css" rel="stylesheet" />
+ <link href="./css/bootswatch.css" rel="stylesheet" />
+ <link href="./css/reflow-skin.css" rel="stylesheet" />
+
+ <link href="http://yandex.st/highlightjs/7.5/styles/default.min.css" rel="stylesheet" />
+
+ <link href="./css/lightbox.css" rel="stylesheet" />
+
+ <link href="./css/site.css" rel="stylesheet" />
+ <link href="./css/print.css" rel="stylesheet" media="print" />
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+
+
+ </head>
+
+ <body class="page-contributing project-phoenix-site" data-spy="scroll" data-offset="60" data-target="#toc-scroll-target">
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="btn btn-navbar" data-toggle="collapse" data-target="#top-nav-collapse">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+ <a class="brand" href="index.html"><div class="xtoplogo"></div></a>
+ <div class="nav-collapse collapse" id="top-nav-collapse">
+ <ul class="nav pull-right">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">About <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li ><a href="index.html" title="Overview">Overview</a></li>
+ <li ><a href="recent.html" title="New Features">New Features</a></li>
+ <li ><a href="roadmap.html" title="Roadmap">Roadmap</a></li>
+ <li ><a href="performance.html" title="Performance">Performance</a></li>
+ <li ><a href="team.html" title="Team">Team</a></li>
+ <li class="active"><a href="" title="Contributing">Contributing</a></li>
+ <li ><a href="resources.html" title="Resources">Resources</a></li>
+ <li ><a href="mailing_list.html" title="Mailing Lists">Mailing Lists</a></li>
+ <li ><a href="source.html" title="Source Repository">Source Repository</a></li>
+ <li ><a href="issues.html" title="Issue Tracking">Issue Tracking</a></li>
+ <li ><a href="download.html" title="Download">Download</a></li>
+ <li class="divider"/>
+ <li ><a href="http://www.apache.org/licenses/" title="License" class="externalLink">License</a></li>
+ <li ><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship" class="externalLink">Sponsorship</a></li>
+ <li ><a href="http://www.apache.org/foundation/thanks.html" title="Thanks" class="externalLink">Thanks</a></li>
+ <li ><a href="http://www.apache.org/security/" title="Security" class="externalLink">Security</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Using <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li ><a href="faq.html" title="F.A.Q.">F.A.Q.</a></li>
+ <li ><a href="Phoenix-in-15-minutes-or-less.html" title="Quick Start">Quick Start</a></li>
+ <li ><a href="building.html" title="Building">Building</a></li>
+ <li ><a href="tuning.html" title="Tuning">Tuning</a></li>
+ <li ><a href="upgrade_from_2_2.html" title="Upgrade from 2.2">Upgrade from 2.2</a></li>
+ <li class="divider"/>
+ <li ><a href="secondary_indexing.html" title="Secondary Indexes">Secondary Indexes</a></li>
+ <li ><a href="joins.html" title="Joins">Joins</a></li>
+ <li ><a href="views.html" title="Views">Views</a></li>
+ <li ><a href="multi-tenancy.html" title="Multi tenancy">Multi tenancy</a></li>
+ <li ><a href="sequences.html" title="Sequences">Sequences</a></li>
+ <li ><a href="array_type.html" title="ARRAY type">ARRAY type</a></li>
+ <li ><a href="salted.html" title="Salted Tables">Salted Tables</a></li>
+ <li ><a href="paged.html" title="Paged Queries">Paged Queries</a></li>
+ <li ><a href="dynamic_columns.html" title="Dynamic Columns">Dynamic Columns</a></li>
+ <li ><a href="skip_scan.html" title="Skip Scan">Skip Scan</a></li>
+ <li ><a href="bulk_dataload.html" title="Bulk Loading">Bulk Loading</a></li>
+ <li class="divider"/>
+ <li ><a href="phoenix_on_emr.html" title="Amazon EMR Support">Amazon EMR Support</a></li>
+ <li ><a href="flume.html" title="Apache Flume Plugin">Apache Flume Plugin</a></li>
+ <li ><a href="pig_integration.html" title="Apache Pig Integration">Apache Pig Integration</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Reference <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li ><a href="language/index.html" title="Grammar">Grammar</a></li>
+ <li ><a href="language/functions.html" title="Functions">Functions</a></li>
+ <li ><a href="language/datatypes.html" title="Datatypes">Datatypes</a></li>
+ </ul>
+ </li>
+ </ul>
+ </div><!--/.nav-collapse -->
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+
+ <!-- Masthead
+ ================================================== -->
+
+ <header>
+ </header>
+
+ <div class="main-body">
+ <div class="row">
+ <div class="span12">
+ <div class="body-content">
+<div class="page-header">
+ <h1>Contributing</h1>
+</div>
+<div class="section">
+ <h2 id="General_process">General process</h2>
+ <p>The general process for contributing code to Phoenix works as follows:</p>
+ <ol style="list-style-type: decimal">
+ <li>Discuss your changes on the dev mailing list</li>
+ <li>Create a JIRA issue unless there already is one</li>
+ <li>Prepare a patch containing your changes</li>
+ <li>Submit the patch</li>
+ </ol>
+ <p>These steps are explained in greater detail below.</p>
+ <div class="section">
+ <h3 id="Discuss_on_the_mailing_list">Discuss on the mailing list</h3>
+ <p>Itâs often best to discuss a change on the public mailing lists before creating and sumbitting a patch.</p>
+ <p>If youâre unsure whether certain behavior in Phoenix is a bug, please send a mail to the <a href="mailing_list.html">user mailing list</a> to check.</p>
+ <p>If youâre considering adding major new functionality to Phoenix, itâs a good idea to first discuss the idea on the <a href="mailing_list.html">developer mailing list</a> to make sure that your plans are in line with others in the Phoenix community.</p>
+ </div>
+ <div class="section">
+ <h3 id="Log_a_JIRA_ticket">Log a JIRA ticket</h3>
+ <p>The first step is to create a ticket on the <a class="externalLink" href="http://issues.apache.org/jira/browse/PHOENIX">Phoenix JIRA</a>. </p>
+ </div>
+ <div class="section">
+ <h3 id="Generate_a_patch">Generate a patch</h3>
+ <p>There are two general approaches that can be used for creating and submitting a patch: GitHub pull requests, or manually creating a patch with Git. Both of these are explained below.</p>
+ <p>Regardless of which approach is taken, please make sure to follow the Phoenix code conventions (more information below). Whenever possible, unit tests or integration tests should be included with patches.</p>
+ <p>The commit message should reference the jira ticket issue (which has the format <tt>PHOENIX-{NUMBER}</tt>).</p>
+ <div class="section">
+ <h4 id="GitHub_workflow">GitHub workflow</h4>
+ <ol style="list-style-type: decimal">
+ <li>Create a pull request in GitHub for the <a class="externalLink" href="https://github.com/apache/incubator-phoenix">mirror of the Phoenix Git repository</a>.</li>
+ <li>Add a comment in the Jira issue with a link to the pull request. This makes it clear that the patch is ready for review.</li>
+ </ol>
+ </div>
+ <div class="section">
+ <h4 id="Local_Git_workflow">Local Git workflow</h4>
+ <ol style="list-style-type: decimal">
+ <li>Create a local branch <tt>git checkout -b <branch name></tt></li>
+ <li>Make and commit changes</li>
+ <li> <p>Generate a patch based on the name of the JIRA issue, as follows:</p> <p><tt>git format-patch --stdout master > PHOENIX-{NUMBER}.patch</tt></p></li>
+ <li> <p>Attach the created patch file to the jira ticket</p></li>
+ </ol>
+ </div>
+ </div>
+</div>
+<div class="section">
+ <h2 id="Code_conventions">Code conventions</h2>
+ <p>The Phoenix code conventions are similar to the <a class="externalLink" href="http://www.oracle.com/technetwork/java/index-135089.html">Sun/Oracle Java Code Convention</a>. We use 4 spaces (no tabs) for indentation, and limit lines to 100 characters.</p>
+ <p>Eclipse code formatting settings and import order settings (which can also be imported into Intellij IDEA) are available in the dev directory of the Phoenix codebase.</p>
+ <p>All new source files should include the Apache license header.</p>
+ <h1>Committer workflow</h1>
+ <p>In general, the ârebaseâ workflow should be used with the Phoenix codebase (see <a class="externalLink" href="http://randyfay.com/content/rebase-workflow-git">this blog post</a> for more information on the difference between the âmergeâ and ârebaseâ workflows in Git).</p>
+ <p>A patch file can be downloaded from a GitHub pull request by adding â.patchâ to the end of the pull request url, e.g. <a class="externalLink" href="https://github.com/apache/incubator-phoenix/pull/35.patch">https://github.com/apache/incubator-phoenix/pull/35.patch</a></p>
+ <p>When applying a patch contributed from a user, please use the âgit amâ command if a fully-formatted patch file is available, as this preserves the contributorâs contact information. Otherwise, the contributorâs name should be added to the commit messge.</p>
+ <p>If a single ticket consists of a patch with multiple commits, the commits can be squashed into a single commit using <tt>git rebase</tt>.</p>
+ <h1>Contributing</h1>
+</div>
+<div class="section">
+ <h2 id="General_process">General process</h2>
+ <p>The general process for contributing code to Phoenix works as follows:</p>
+ <ol style="list-style-type: decimal">
+ <li>Discuss your changes on the dev mailing list</li>
+ <li>Create a JIRA issue unless there already is one</li>
+ <li>Prepare a patch containing your changes</li>
+ <li>Submit the patch</li>
+ </ol>
+ <p>These steps are explained in greater detail below.</p>
+ <div class="section">
+ <h3 id="Discuss_on_the_mailing_list">Discuss on the mailing list</h3>
+ <p>Itâs often best to discuss a change on the public mailing lists before creating and sumbitting a patch.</p>
+ <p>If youâre unsure whether certain behavior in Phoenix is a bug, please send a mail to the <a href="mailing_list.html">user mailing list</a> to check.</p>
+ <p>If youâre considering adding major new functionality to Phoenix, itâs a good idea to first discuss the idea on the <a href="mailing_list.html">developer mailing list</a> to make sure that your plans are in line with others in the Phoenix community.</p>
+ </div>
+ <div class="section">
+ <h3 id="Log_a_JIRA_ticket">Log a JIRA ticket</h3>
+ <p>The first step is to create a ticket on the <a class="externalLink" href="http://issues.apache.org/jira/browse/PHOENIX">Phoenix JIRA</a>. </p>
+ </div>
+ <div class="section">
+ <h3 id="Generate_a_patch">Generate a patch</h3>
+ <p>There are two general approaches that can be used for creating and submitting a patch: GitHub pull requests, or manually creating a patch with Git. Both of these are explained below.</p>
+ <p>Regardless of which approach is taken, please make sure to follow the Phoenix code conventions (more information below). Whenever possible, unit tests or integration tests should be included with patches.</p>
+ <p>The commit message should reference the jira ticket issue (which has the format <tt>PHOENIX-{NUMBER}</tt>).</p>
+ <div class="section">
+ <h4 id="GitHub_workflow">GitHub workflow</h4>
+ <ol style="list-style-type: decimal">
+ <li>Create a pull request in GitHub for the <a class="externalLink" href="https://github.com/apache/incubator-phoenix">mirror of the Phoenix Git repository</a>.</li>
+ <li>Add a comment in the Jira issue with a link to the pull request. This makes it clear that the patch is ready for review.</li>
+ </ol>
+ </div>
+ <div class="section">
+ <h4 id="Local_Git_workflow">Local Git workflow</h4>
+ <ol style="list-style-type: decimal">
+ <li>Create a local branch <tt>git checkout -b <branch name></tt></li>
+ <li>Make and commit changes</li>
+ <li> <p>Generate a patch based on the name of the JIRA issue, as follows:</p> <p><tt>git format-patch --stdout master > PHOENIX-{NUMBER}.patch</tt></p></li>
+ <li> <p>Attach the created patch file to the jira ticket</p></li>
+ </ol>
+ </div>
+ </div>
+</div>
+<div class="section">
+ <h2 id="Code_conventions">Code conventions</h2>
+ <p>The Phoenix code conventions are similar to the <a class="externalLink" href="http://www.oracle.com/technetwork/java/index-135089.html">Sun/Oracle Java Code Convention</a>. We use 4 spaces (no tabs) for indentation, and limit lines to 100 characters.</p>
+ <p>Eclipse code formatting settings and import order settings (which can also be imported into Intellij IDEA) are available in the dev directory of the Phoenix codebase.</p>
+ <p>All new source files should include the Apache license header.</p>
+ <h1>Committer workflow</h1>
+ <p>In general, the ârebaseâ workflow should be used with the Phoenix codebase (see <a class="externalLink" href="http://randyfay.com/content/rebase-workflow-git">this blog post</a> for more information on the difference between the âmergeâ and ârebaseâ workflows in Git).</p>
+ <p>A patch file can be downloaded from a GitHub pull request by adding â.patchâ to the end of the pull request url, e.g. <a class="externalLink" href="https://github.com/apache/incubator-phoenix/pull/35.patch">https://github.com/apache/incubator-phoenix/pull/35.patch</a></p>
+ <p>When applying a patch contributed from a user, please use the âgit amâ command if a fully-formatted patch file is available, as this preserves the contributorâs contact information. Otherwise, the contributorâs name should be added to the commit messge.</p>
+ <p>If a single ticket consists of a patch with multiple commits, the commits can be squashed into a single commit using <tt>git rebase</tt>.</p>
+</div>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ </div><!-- /container -->
+
+ <!-- Footer
+ ================================================== -->
+ <footer class="well">
+ <div class="container">
+ <div class="row">
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">About</li>
+ <li >
+ <a href="index.html" title="Overview">Overview</a>
+ </li>
+ <li >
+ <a href="recent.html" title="New Features">New Features</a>
+ </li>
+ <li >
+ <a href="roadmap.html" title="Roadmap">Roadmap</a>
+ </li>
+ <li >
+ <a href="performance.html" title="Performance">Performance</a>
+ </li>
+ <li >
+ <a href="team.html" title="Team">Team</a>
+ </li>
+ <li class="active">
+ <a href="#" title="Contributing">Contributing</a>
+ </li>
+ <li >
+ <a href="resources.html" title="Resources">Resources</a>
+ </li>
+ <li >
+ <a href="mailing_list.html" title="Mailing Lists">Mailing Lists</a>
+ </li>
+ <li >
+ <a href="source.html" title="Source Repository">Source Repository</a>
+ </li>
+ <li >
+ <a href="issues.html" title="Issue Tracking">Issue Tracking</a>
+ </li>
+ <li >
+ <a href="download.html" title="Download">Download</a>
+ </li>
+ <li >
+ <a href="http:divider" title=""></a>
+ </li>
+ <li >
+ <a href="http://www.apache.org/licenses/" title="License" class="externalLink">License</a>
+ </li>
+ <li >
+ <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship" class="externalLink">Sponsorship</a>
+ </li>
+ <li >
+ <a href="http://www.apache.org/foundation/thanks.html" title="Thanks" class="externalLink">Thanks</a>
+ </li>
+ <li >
+ <a href="http://www.apache.org/security/" title="Security" class="externalLink">Security</a>
+ </li>
+ </ul>
+ </div>
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Using</li>
+ <li >
+ <a href="faq.html" title="F.A.Q.">F.A.Q.</a>
+ </li>
+ <li >
+ <a href="Phoenix-in-15-minutes-or-less.html" title="Quick Start">Quick Start</a>
+ </li>
+ <li >
+ <a href="building.html" title="Building">Building</a>
+ </li>
+ <li >
+ <a href="tuning.html" title="Tuning">Tuning</a>
+ </li>
+ <li >
+ <a href="upgrade_from_2_2.html" title="Upgrade from 2.2">Upgrade from 2.2</a>
+ </li>
+ <li >
+ <a href="http:divider" title=""></a>
+ </li>
+ <li >
+ <a href="secondary_indexing.html" title="Secondary Indexes">Secondary Indexes</a>
+ </li>
+ <li >
+ <a href="joins.html" title="Joins">Joins</a>
+ </li>
+ <li >
+ <a href="views.html" title="Views">Views</a>
+ </li>
+ <li >
+ <a href="multi-tenancy.html" title="Multi tenancy">Multi tenancy</a>
+ </li>
+ <li >
+ <a href="sequences.html" title="Sequences">Sequences</a>
+ </li>
+ <li >
+ <a href="array_type.html" title="ARRAY type">ARRAY type</a>
+ </li>
+ <li >
+ <a href="salted.html" title="Salted Tables">Salted Tables</a>
+ </li>
+ <li >
+ <a href="paged.html" title="Paged Queries">Paged Queries</a>
+ </li>
+ <li >
+ <a href="dynamic_columns.html" title="Dynamic Columns">Dynamic Columns</a>
+ </li>
+ <li >
+ <a href="skip_scan.html" title="Skip Scan">Skip Scan</a>
+ </li>
+ <li >
+ <a href="bulk_dataload.html" title="Bulk Loading">Bulk Loading</a>
+ </li>
+ <li >
+ <a href="http:divider" title=""></a>
+ </li>
+ <li >
+ <a href="phoenix_on_emr.html" title="Amazon EMR Support">Amazon EMR Support</a>
+ </li>
+ <li >
+ <a href="flume.html" title="Apache Flume Plugin">Apache Flume Plugin</a>
+ </li>
+ <li >
+ <a href="pig_integration.html" title="Apache Pig Integration">Apache Pig Integration</a>
+ </li>
+ </ul>
+ </div>
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Reference</li>
+ <li >
+ <a href="language/index.html" title="Grammar">Grammar</a>
+ </li>
+ <li >
+ <a href="language/functions.html" title="Functions">Functions</a>
+ </li>
+ <li >
+ <a href="language/datatypes.html" title="Datatypes">Datatypes</a>
+ </li>
+ </ul>
+ </div>
+ <div class="span3 bottom-description">
+ <form action="https://www.google.com/search" method="get"><input value="phoenix.incubator.apache.org" name="sitesearch" type="hidden"><input placeholder="Search the site…" required="required" style="width:170px;" size="18" name="q" id="query" type="search"></form>
+ </div>
+ </div>
+ </div>
+ </footer>
+
+ <div class="container subfooter">
+ <div class="row">
+ <div class="span12">
+ <p class="pull-right"><a href="#">Back to top</a></p>
+ <p class="copyright">Copyright ©2014 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.</p>
+ </div>
+ </div>
+ </div>
+
+ <!-- Le javascript
+ ================================================== -->
+ <!-- Placed at the end of the document so the pages load faster -->
+ <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
+
+ <script src="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/js/bootstrap.min.js"></script>
+ <script src="./js/lightbox.js"></script>
+ <script src="./js/jquery.smooth-scroll.min.js"></script>
+ <!-- back button support for smooth scroll -->
+ <script src="./js/jquery.ba-bbq.min.js"></script>
+ <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
+
+ <script src="./js/reflow-skin.js"></script>
+
+ </body>
+</html>