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:36:37 UTC
[1/3] incubator-tinkerpop git commit: Added "Getting Started" to the
developer docs for new contributors.
Repository: incubator-tinkerpop
Updated Branches:
refs/heads/master c4fcae6a9 -> 863bdab1f
Added "Getting Started" to the developer docs for new contributors.
Includes notes on low-hanging fruit = trivial priority in jira as discussed on the dev mailing list.
https://pony-poc.apache.org/thread.html/da7265b799b4bfca98f0094cc9df83d3c67e1de507aaeb6c1015e32a@1445013066@%3Cdev.tinkerpop.apache.org%3E
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/bfb99f3b
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/bfb99f3b
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/bfb99f3b
Branch: refs/heads/master
Commit: bfb99f3bbac6e811b3a880f13fa6cc9e2bb64640
Parents: ebec095
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Wed Nov 4 13:46:02 2015 -0500
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Wed Nov 4 13:46:02 2015 -0500
----------------------------------------------------------------------
docs/src/developer-contributing.asciidoc | 27 +++++++++++++++++++++++----
1 file changed, 23 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/bfb99f3b/docs/src/developer-contributing.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/developer-contributing.asciidoc b/docs/src/developer-contributing.asciidoc
index 951c1b0..acf5dc8 100644
--- a/docs/src/developer-contributing.asciidoc
+++ b/docs/src/developer-contributing.asciidoc
@@ -17,10 +17,26 @@ limitations under the License.
Contributing
============
-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's open source license and
-warrant that you have the legal authority to do so.
+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's open source
+license and warrant that you have the legal authority to do so.
+
+Getting Started
+---------------
+
+New contributors can start development with TinkerPop by first link:https://help.github.com/articles/fork-a-repo/[forking
+then cloning] the Apache TinkerPop link:https://github.com/apache/incubator-tinkerpop[GitHub repository]. Generally
+speaking it is best to tie any work done to an issue in link:https://issues.apache.org/jira/browse/TINKERPOP3[JIRA].
+Either scan through JIRA for an existing open issue to work on or create a new one.
+
+NOTE: 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
+link: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]
+for newcomers.
+
+After making changes, submit a link:https://help.github.com/articles/using-pull-requests/[pull request] 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.
Building and Testing
--------------------
@@ -161,6 +177,9 @@ as one that is representative of a change in the API that might affect users or
organizing release notes.
* The "affects/fix version(s)" fields should be appropriately set, where the "fix version" implies the version on
which that particular issue will completed.
+* 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.
Code Style
~~~~~~~~~~
[2/3] incubator-tinkerpop git commit: Added a bit more to the
"getting started" contributor docs.
Posted by sp...@apache.org.
Added a bit more to the "getting started" contributor docs.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/88abff69
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/88abff69
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/88abff69
Branch: refs/heads/master
Commit: 88abff69f7cbecc04fa4db5ca06f52e942bd109b
Parents: bfb99f3
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Wed Nov 4 14:36:02 2015 -0500
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Wed Nov 4 14:36:02 2015 -0500
----------------------------------------------------------------------
docs/src/developer-contributing.asciidoc | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/88abff69/docs/src/developer-contributing.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/developer-contributing.asciidoc b/docs/src/developer-contributing.asciidoc
index acf5dc8..fceedb2 100644
--- a/docs/src/developer-contributing.asciidoc
+++ b/docs/src/developer-contributing.asciidoc
@@ -38,6 +38,21 @@ After making changes, submit a link:https://help.github.com/articles/using-pull-
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.
+Before issuing your pull request, please be sure of the following:
+
+. `mvn clean install` works successfully.
+. If the change requires modification to the documentation, which can be found in `docs/src`, 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 `bin/process-docs.sh --dryRun`. If there are code examples,
+please be sure to have Zookeeper and Hadoop running when doing a `bin/process-docs.sh`. The documentation is
+generated to `/target/docs/htmlsingle`.
+. 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 `mvn clean install`, do `mvn verify -DskipIntegrationTests=false -pl gremlin-server`.
+
+Once a pull request is submitted it must go through <<rtc,review>> and will be merged once three TinkerPop committers
+offer positive vote and achieve Apache consensus.
+
Building and Testing
--------------------
@@ -232,6 +247,7 @@ When writing a test case for a Gremlin step, be sure to use the following conven
** `checkResults(Arrays.asList("marko","josh"), traversal)`
** `checkMap(new HashMap<String,Long>() {{ put("marko",1l); }}, traversal.next())`
+[rtc]
Review then Commit
~~~~~~~~~~~~~~~~~~
[3/3] incubator-tinkerpop git commit: Merge remote-tracking branch
'origin/master'
Posted by sp...@apache.org.
Merge remote-tracking branch 'origin/master'
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/863bdab1
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/863bdab1
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/863bdab1
Branch: refs/heads/master
Commit: 863bdab1f62b82001efabc1cd06b87382d2d263b
Parents: 88abff6 c4fcae6
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Wed Nov 4 14:36:30 2015 -0500
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Wed Nov 4 14:36:30 2015 -0500
----------------------------------------------------------------------
CHANGELOG.asciidoc | 2 +
docs/src/implementations.asciidoc | 9 ++
docs/src/the-graphcomputer.asciidoc | 4 +
.../computer/bulkloading/BulkLoader.java | 31 +++++
.../bulkloading/BulkLoaderVertexProgram.java | 115 ++++++++++++++++---
.../bulkloading/IncrementalBulkLoader.java | 14 ++-
.../process/computer/SparkGraphComputer.java | 32 ++++++
.../process/computer/LocalPropertyTest.java | 100 ++++++++++++++++
.../structure/TinkerGraphPlayTest.java | 19 ++-
9 files changed, 304 insertions(+), 22 deletions(-)
----------------------------------------------------------------------