tinkerpop-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From spmalle...@apache.org
Subject [21/24] incubator-tinkerpop git commit: Removed a note about deprecation in dev docs that didn't make sense.
Date Wed, 27 Apr 2016 17:59:11 GMT
Removed a note about deprecation in dev docs that didn't make sense.

Deprecation work need not be tied to a JIRA ticket with a "breaking" label. If we deprecated
properly, there should be no breaking change and hence no need for the label.  CTR


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

Branch: refs/heads/TINKERPOP-1179
Commit: f23def3afbd658024a8d08294048beb4566c4800
Parents: 606b59a
Author: Stephen Mallette <spmva@genoprime.com>
Authored: Tue Apr 26 07:43:24 2016 -0400
Committer: Stephen Mallette <spmva@genoprime.com>
Committed: Tue Apr 26 07:43:24 2016 -0400

----------------------------------------------------------------------
 docs/src/dev/developer/contributing.asciidoc | 3 ---
 1 file changed, 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/f23def3a/docs/src/dev/developer/contributing.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/dev/developer/contributing.asciidoc b/docs/src/dev/developer/contributing.asciidoc
index b33aeb9..ffc8156 100644
--- a/docs/src/dev/developer/contributing.asciidoc
+++ b/docs/src/dev/developer/contributing.asciidoc
@@ -270,9 +270,6 @@ replaced then the comment can simply read "not replaced".  Additional
comments t
 encouraged.
 ** `@see <a href="https://issues.apache.org/jira/browse/TINKERPOP-XXX">TINKERPOP-XXX</a>`
- supply a link to the
 JIRA issue for reference.
-* All deprecation should typically 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


Mime
View raw message