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 2015/11/04 21:41:06 UTC
svn commit: r1712639 -
/incubator/tinkerpop/site/docs/3.1.0-SNAPSHOT/developer.html
Author: spmallette
Date: Wed Nov 4 20:41:06 2015
New Revision: 1712639
URL: http://svn.apache.org/viewvc?rev=1712639&view=rev
Log:
Add notes about deprecation label in jira.
Modified:
incubator/tinkerpop/site/docs/3.1.0-SNAPSHOT/developer.html
Modified: incubator/tinkerpop/site/docs/3.1.0-SNAPSHOT/developer.html
URL: http://svn.apache.org/viewvc/incubator/tinkerpop/site/docs/3.1.0-SNAPSHOT/developer.html?rev=1712639&r1=1712638&r2=1712639&view=diff
==============================================================================
--- incubator/tinkerpop/site/docs/3.1.0-SNAPSHOT/developer.html (original)
+++ incubator/tinkerpop/site/docs/3.1.0-SNAPSHOT/developer.html Wed Nov 4 20:41:06 2015
@@ -1123,8 +1123,8 @@ a branch name prefix. This provides a u
<div class="sect2">
<h3 id="_tags">Tags</h3>
<div class="paragraph">
-<p>Tags are used for milestones, release candidates, and approved releases. Please
-refrain from creating arbitrary tags, as they produce permanent clutter.</p>
+<p>Tags are used for milestones, release candidates, and approved releases. Please refrain from creating arbitrary
+tags, as they produce permanent clutter.</p>
</div>
</div>
<div class="sect2">
@@ -1173,9 +1173,18 @@ reasonable workaround. Given that defin
this property set.</p>
</li>
<li>
-<p>Issues are not assigned "labels" with one exception: the "breaking" label. The "breaking" label marks an issue
-as one that is representative of a change in the API that might affect users or vendors. This label is important when
-organizing release notes.</p>
+<p>Issues are not assigned "labels" with two exceptions:</p>
+<div class="ulist">
+<ul>
+<li>
+<p>The "breaking" label which marks an issue as one that is representative of a change in the API that might
+affect users or vendors. This label is important when organizing release notes.</p>
+</li>
+<li>
+<p>The "deprecation" label which is assigned to an issue that is about removing a deprecated portion of the API.</p>
+</li>
+</ul>
+</div>
</li>
<li>
<p>The "affects/fix version(s)" fields should be appropriately set, where the "fix version" implies the version on
@@ -1226,7 +1235,7 @@ JIRA issue for reference.</p>
</div>
</li>
<li>
-<p>All deprecation should be tied to a JIRA issue with a "breaking" label - the issue itself does not need to
+<p>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.</p>
</li>
@@ -1236,10 +1245,10 @@ call out this fact.</p>
</li>
<li>
<p>Create a new JIRA issue to track removal of the deprecation for future evaluation - this issue should have the
-"breaking" label.</p>
+"breaking" label as well as a "deprecation" label.</p>
</li>
<li>
-<p>Provide a post to the developers and/or users mailing lists as the case requires to alert the community to the change.</p>
+<p>Update the "upgrade documentation" to reflect the API change and how the reader should resolve it.</p>
</li>
</ul>
</div>
@@ -2006,7 +2015,7 @@ roadmap:</p>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2015-11-04 14:49:43 -05:00
+Last updated 2015-11-04 15:21:29 -05:00
</div>
</div>
</body>