You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2015/11/04 20:01:02 UTC

svn commit: r1712613 - /incubator/tinkerpop/site/docs/3.1.0-SNAPSHOT/developer.html

Author: spmallette
Date: Wed Nov  4 19:01:02 2015
New Revision: 1712613

URL: http://svn.apache.org/viewvc?rev=1712613&view=rev
Log:
Add "getting started" to contributing guide for newcomers.

Modified:
    incubator/tinkerpop/site/docs/3.1.0-SNAPSHOT/developer.html

Modified: incubator/tinkerpop/site/docs/3.1.0-SNAPSHOT/developer.html
URL: http://svn.apache.org/viewvc/incubator/tinkerpop/site/docs/3.1.0-SNAPSHOT/developer.html?rev=1712613&r1=1712612&r2=1712613&view=diff
==============================================================================
--- incubator/tinkerpop/site/docs/3.1.0-SNAPSHOT/developer.html (original)
+++ incubator/tinkerpop/site/docs/3.1.0-SNAPSHOT/developer.html Wed Nov  4 19:01:02 2015
@@ -800,6 +800,7 @@ span.line-numbers { border-right: 1px so
 <li><a href="#_contributing">Contributing</a></li>
 <li>
 <ul class="sectlevel1">
+<li><a href="#_getting_started">Getting Started</a></li>
 <li><a href="#_building_and_testing">Building and Testing</a></li>
 <li><a href="#_ide_setup_with_intellij">IDE Setup with Intellij</a></li>
 <li><a href="#_for_committers">For Committers</a></li>
@@ -855,10 +856,40 @@ technical information and other internal
 </div>
 <h1 id="_contributing" class="sect0">Contributing</h1>
 <div class="paragraph">
-<p>Contributions via GitHub pull requests are gladly accepted from their original
-author. By submitting any copyrighted material via pull request, email, or other means
-you agree to license the material under the project&#8217;s open source license and
-warrant that you have the legal authority to do so.</p>
+<p>Contributions via GitHub pull requests are gladly accepted from their original author. By submitting any copyrighted
+material via pull request, email, or other means you agree to license the material under the project&#8217;s open source
+license and warrant that you have the legal authority to do so.</p>
+</div>
+<div class="sect1">
+<h2 id="_getting_started">Getting Started</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>New contributors can start development with TinkerPop by first <a href="https://help.github.com/articles/fork-a-repo/">forking
+then cloning</a> the Apache TinkerPop <a href="https://github.com/apache/incubator-tinkerpop">GitHub repository</a>. Generally
+speaking it is best to tie any work done to an issue in <a href="https://issues.apache.org/jira/browse/TINKERPOP3">JIRA</a>.
+Either scan through JIRA for an existing open issue to work on or create a new one.</p>
+</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">
+For those who are trying to find a place to start to contribute, consider looking at unresolved issues that
+have the "trivial" priority as these issues are specifically set aside as
+<a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20TINKERPOP3%20AND%20resolution%20%3D%20Unresolved%20AND%20priority%20%3D%20Trivial%20ORDER%20BY%20key%20DESC">low-hanging fruit</a>
+for newcomers.
+</td>
+</tr>
+</table>
+</div>
+<div class="paragraph">
+<p>After making changes, submit a <a href="https://help.github.com/articles/using-pull-requests/">pull request</a> through
+GitHub, where the name of the pull request is prefixed with the JIRA issue number.  In this way, the pull request
+and its comments get tied back to the JIRA issue it references.</p>
+</div>
+</div>
 </div>
 <div class="sect1">
 <h2 id="_building_and_testing">Building and Testing</h2>
@@ -1124,6 +1155,11 @@ organizing release notes.</p>
 <p>The "affects/fix version(s)" fields should be appropriately set, where the "fix version" implies the version on
 which that particular issue will completed.</p>
 </li>
+<li>
+<p>The "priority" field can be arbitrarily applied with one exception.  The "trivial" option should be reserved for
+tasks that are "easy" for a potential new contributor to jump into and do not have significant impact to urgently
+required improvements.</p>
+</li>
 </ul>
 </div>
 </div>
@@ -1944,7 +1980,7 @@ roadmap:</p>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2015-10-30 11:46:21 MDT
+Last updated 2015-11-04 13:48:35 -05:00
 </div>
 </div>
 </body>