incubator-tinkerpop git commit: More about deprecation.

[sp...@apache.org]

Repository: incubator-tinkerpop
Updated Branches:
  refs/heads/tp30 11da4591a -> dd6bcfb6b


More about deprecation.


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

Branch: refs/heads/tp30
Commit: dd6bcfb6b23525863e1073e304f6a5aea0ca3c35
Parents: 11da459
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Wed Sep 9 09:40:10 2015 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Wed Sep 9 09:40:10 2015 -0400

----------------------------------------------------------------------
 CONTRIBUTING.asciidoc | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/dd6bcfb6/CONTRIBUTING.asciidoc
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.asciidoc b/CONTRIBUTING.asciidoc
index 1a29f79..6dd8f9f 100644
--- a/CONTRIBUTING.asciidoc
+++ b/CONTRIBUTING.asciidoc
@@ -160,6 +160,14 @@ 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()}`.
-* All deprecation should be tied to a JIRA issue with a "breaking" label.
+* 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.
+* Be sure that deprecated methods are still under test - consider using javadoc/comments in the tests themselves to
+call out this fact.
+* Create a new JIRA issue to track removal of the deprecation for future evaluation - this issue should have the
+"breaking" label.
 * Provide a post to the developers and/or users mailing lists as the case requires to alert the community to the change.
 
+The JIRA issues that track removal of deprecated methods should be periodically evaluated to determine if it is
+prudent to schedule them into a release.