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:37:17 UTC

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

Author: spmallette
Date: Wed Nov  4 19:37:16 2015
New Revision: 1712619

URL: http://svn.apache.org/viewvc?rev=1712619&view=rev
Log:
Added a few more lines about getting started 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=1712619&r1=1712618&r2=1712619&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:37:16 2015
@@ -889,6 +889,32 @@ for newcomers.
 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 class="paragraph">
+<p>Before issuing your pull request, please be sure of the following:</p>
+</div>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p><code>mvn clean install</code> works successfully.</p>
+</li>
+<li>
+<p>If the change requires modification to the documentation, which can be found in <code>docs/src</code>, please be sure to try to
+generate the docs.  If the changes are minimal and do not include code examples, it might be sufficient to test
+generate the docs to validate formatting by just doing <code>bin/process-docs.sh --dryRun</code>.  If there are code examples,
+please be sure to have Zookeeper and Hadoop running when doing a <code>bin/process-docs.sh</code>.  The documentation is
+generated to <code>/target/docs/htmlsingle</code>.</p>
+</li>
+<li>
+<p>If necessary, run the integration tests.  For example, if the changes affect serialization or Gremlin Server/Driver
+operations then running the integration tests assures in addition to unit tests will definitely be necessary. After
+a successful <code>mvn clean install</code>, do <code>mvn verify -DskipIntegrationTests=false -pl gremlin-server</code>.</p>
+</li>
+</ol>
+</div>
+<div class="paragraph">
+<p>Once a pull request is submitted it must go through <a href="#rtc">review</a> and will be merged once three TinkerPop committers
+offer positive vote and achieve Apache consensus.</p>
+</div>
 </div>
 </div>
 <div class="sect1">
@@ -1980,7 +2006,7 @@ roadmap:</p>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2015-11-04 13:48:35 -05:00
+Last updated 2015-11-04 14:25:55 -05:00
 </div>
 </div>
 </body>