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 2017/06/23 12:28:14 UTC
tinkerpop git commit: Modified docs on how the "deprecation" label
should be used
Repository: tinkerpop
Updated Branches:
refs/heads/tp32 a104680d3 -> 984b34d34
Modified docs on how the "deprecation" label should be used
Discussed here: https://lists.apache.org/thread.html/70f9123afb0273bc5019ea54463c068bdcb719a8dd86d7c8c1872bb8@%3Cdev.tinkerpop.apache.org%3E CTR
Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/984b34d3
Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/984b34d3
Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/984b34d3
Branch: refs/heads/tp32
Commit: 984b34d34469e3f0a79357414a4ae881843ca48b
Parents: a104680
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Fri Jun 23 08:26:38 2017 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Fri Jun 23 08:26:38 2017 -0400
----------------------------------------------------------------------
docs/src/dev/developer/for-committers.asciidoc | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/984b34d3/docs/src/dev/developer/for-committers.asciidoc
----------------------------------------------------------------------
diff --git a/docs/src/dev/developer/for-committers.asciidoc b/docs/src/dev/developer/for-committers.asciidoc
index 68afdc3..3593056 100644
--- a/docs/src/dev/developer/for-committers.asciidoc
+++ b/docs/src/dev/developer/for-committers.asciidoc
@@ -111,7 +111,7 @@ this property set.
* Issues are not assigned "labels" with two exceptions:
** The "breaking" label which marks an issue as one that is representative of a change in the API that might
affect users or providers. This label is important when organizing release notes.
-** The "deprecation" label which is assigned to an issue that is about removing a deprecated portion of the API.
+** The "deprecation" label which is assigned to an issue that includes changes to deprecate a portion of the API.
* The "affects/fix version(s)" fields should be appropriately set, where the "fix version" implies the version on
which that particular issue will completed. This is a field usually only set by committers.
* The "priority" field can be arbitrarily applied with one exception. The "trivial" option should be reserved for
@@ -146,11 +146,10 @@ public APIs that might be utilized by users or implemented by providers:
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/TINKERPOP-XXX">TINKERPOP-XXX</a>` - supply a link to the
-JIRA issue for reference.
+JIRA issue for reference - the issue should include the "deprecation" label.
* 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 as well as a "deprecation" label.
+* Create a new JIRA issue to track removal of the deprecation for future evaluation.
* Update the "upgrade documentation" to reflect the API change and how the reader should resolve it.
The JIRA issues that track removal of deprecated methods should be periodically evaluated to determine if it is