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 2016/02/16 18:17:45 UTC
[08/10] incubator-tinkerpop git commit: Added Apache Gremlin to
contributing docs.
Added Apache Gremlin to contributing 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/7b8ce4ba
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/7b8ce4ba
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/7b8ce4ba
Branch: refs/heads/TINKERPOP-1148-wip
Commit: 7b8ce4bafa0b14322b0be8e3faf7869fb3757620
Parents: 4aeb4b2
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Tue Feb 16 08:28:22 2016 -0500
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Tue Feb 16 08:28:22 2016 -0500
----------------------------------------------------------------------
docs/src/dev/developer/contributing.asciidoc | 22 ++++++++++++----------
1 file changed, 12 insertions(+), 10 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/7b8ce4ba/docs/src/dev/developer/contributing.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/dev/developer/contributing.asciidoc b/docs/src/dev/developer/contributing.asciidoc
index 730e7f1..88d600c 100644
--- a/docs/src/dev/developer/contributing.asciidoc
+++ b/docs/src/dev/developer/contributing.asciidoc
@@ -24,19 +24,16 @@ 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/TINKERPOP[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%20TINKERPOP%20AND%20resolution%20%3D%20Unresolved%20AND%20priority%20%3D%20Trivial%20ORDER%20BY%20key%20DESC[low-hanging fruit]
-for newcomers.
+image:gremlin-apache.png[width=250,float=left] 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/TINKERPOP[JIRA]. Either scan through JIRA for an
+existing open issue to work on or create a new one.
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.
+and its comments get tied back to the JIRA issue it references, thus triggering automation that pushes GitHub comments
+into the JIRA ticket.
Before issuing your pull request, please be sure of the following:
@@ -56,6 +53,11 @@ a successful `mvn clean install`, do `mvn verify -DskipIntegrationTests=false -p
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.
+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%20TINKERPOP%20AND%20resolution%20%3D%20Unresolved%20AND%20priority%20%3D%20Trivial%20ORDER%20BY%20key%20DESC[low-hanging fruit]
+for newcomers.
+
[[building-testing]]
Building and Testing
--------------------