[28/33] incubator-tinkerpop git commit: More on contributing.

[ok...@apache.org]

More on contributing.


Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/a4928c0e
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/a4928c0e
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/a4928c0e

Branch: refs/heads/hadoop_split
Commit: a4928c0eae39cd6fc7f785d921692f867e8c5acc
Parents: dd6bcfb
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Wed Sep 9 09:56:06 2015 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Wed Sep 9 09:56:06 2015 -0400

----------------------------------------------------------------------
 CONTRIBUTING.asciidoc | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/a4928c0e/CONTRIBUTING.asciidoc
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.asciidoc b/CONTRIBUTING.asciidoc
index 6dd8f9f..50a35a9 100644
--- a/CONTRIBUTING.asciidoc
+++ b/CONTRIBUTING.asciidoc
@@ -158,8 +158,11 @@ deprecation.  Deprecation should come with sufficient documentation and notice e
 public APIs that might be utilized by users or implemented by vendors:
 
 * Mark the code with the `@Deprecated` annotation.
-* Use javadoc to further document the change with the following pattern:
-`@deprecated As of release x.y.z, replaced by {@link SomeOtherClass#someNewMethod()}`.
+* Use javadoc to further document the change with the following content:
+** `@deprecated As of release x.y.z, replaced by {@link SomeOtherClass#someNewMethod()}` - if the method is not
+replaced then the comment can simply read "not replaced".  Additional comments that provide more context are
+encouraged.
+** `@see <a href="https://issues.apache.org/jira/browse/TINKERPOP3-297">TINKERPOP3-297</a>`
 * All deprecation should be tied to a JIRA issue with a "breaking" label - the issue itself does not need to
 specifically or solely be about "deprecation" but it should be documented very clearly in the comments what was
 deprecated and what the path forward should be.