You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spark.apache.org by sr...@apache.org on 2018/08/16 23:01:01 UTC

spark-website git commit: Mention correctness issues as blockers in developer docs; mention 18 month release branch maintenance guideline

Repository: spark-website
Updated Branches:
  refs/heads/asf-site fff22b750 -> 0bef76657


Mention correctness issues as blockers in developer docs; mention 18 month release branch maintenance guideline

Author: Sean Owen <se...@databricks.com>

Closes #136 from srowen/Correctness.


Project: http://git-wip-us.apache.org/repos/asf/spark-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/spark-website/commit/0bef7665
Tree: http://git-wip-us.apache.org/repos/asf/spark-website/tree/0bef7665
Diff: http://git-wip-us.apache.org/repos/asf/spark-website/diff/0bef7665

Branch: refs/heads/asf-site
Commit: 0bef766573fac8e6451c49c271f8edcb8f9c7aff
Parents: fff22b7
Author: Sean Owen <se...@databricks.com>
Authored: Thu Aug 16 16:00:57 2018 -0700
Committer: Sean Owen <se...@databricks.com>
Committed: Thu Aug 16 16:00:57 2018 -0700

----------------------------------------------------------------------
 contributing.md             | 16 ++++++++++++++--
 site/contributing.html      | 19 +++++++++++++++++--
 site/versioning-policy.html | 11 ++++++++---
 versioning-policy.md        | 11 ++++++++---
 4 files changed, 47 insertions(+), 10 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/spark-website/blob/0bef7665/contributing.md
----------------------------------------------------------------------
diff --git a/contributing.md b/contributing.md
index fd9fec0..9b964a8 100644
--- a/contributing.md
+++ b/contributing.md
@@ -244,10 +244,11 @@ Example: `Fix typos in Foo scaladoc`
     1. Set required fields:
         1. **Issue Type**. Generally, Bug, Improvement and New Feature are the only types used in Spark.
         1. **Priority**. Set to Major or below; higher priorities are generally reserved for 
-        committers to set. JIRA tends to unfortunately conflate "size" and "importance" in its 
+        committers to set. The main exception is correctness or data-loss issues, which can be flagged as
+        Blockers. JIRA tends to unfortunately conflate "size" and "importance" in its 
         Priority field values. Their meaning is roughly:
              1. Blocker: pointless to release without this change as the release would be unusable 
-             to a large minority of users
+             to a large minority of users. Correctness and data loss issues should be considered Blockers.
              1. Critical: a large minority of users are missing important functionality without 
              this, and/or a workaround is difficult
              1. Major: a small minority of users are missing important functionality without this, 
@@ -258,6 +259,17 @@ Example: `Fix typos in Foo scaladoc`
         1. **Component**
         1. **Affects Version**. For Bugs, assign at least one version that is known to exhibit the 
         problem or need the change
+        1. **Label**. Not widely used, except for the following:
+             - `correctness`: a correctness issue
+             - `data-loss`: a data loss issue
+             - `release-notes`: the change's effects need mention in release notes. The JIRA or pull request
+             should include detail suitable for inclusion in release notes -- see "Docs Text" below.
+             - `starter`: small, simple change suitable for new contributors
+        1. **Docs Text**: For issues that require an entry in the release notes, this should contain the
+        information that the release manager should include in Release Notes. This should include a short summary
+        of what behavior is impacted, and detail on what behavior changed. It can be provisionally filled out
+        when the JIRA is opened, but will likely need to be updated with final details when the issue is
+        resolved.
     1. Do not set the following fields:
         1. **Fix Version**. This is assigned by committers only when resolved.
         1. **Target Version**. This is assigned by committers to indicate a PR has been accepted for 

http://git-wip-us.apache.org/repos/asf/spark-website/blob/0bef7665/site/contributing.html
----------------------------------------------------------------------
diff --git a/site/contributing.html b/site/contributing.html
index ce8580a..9fc45e5 100644
--- a/site/contributing.html
+++ b/site/contributing.html
@@ -463,11 +463,12 @@ Example: <code>Fix typos in Foo scaladoc</code></li>
         <ol>
           <li><strong>Issue Type</strong>. Generally, Bug, Improvement and New Feature are the only types used in Spark.</li>
           <li><strong>Priority</strong>. Set to Major or below; higher priorities are generally reserved for 
- committers to set. JIRA tends to unfortunately conflate &#8220;size&#8221; and &#8220;importance&#8221; in its 
+ committers to set. The main exception is correctness or data-loss issues, which can be flagged as
+ Blockers. JIRA tends to unfortunately conflate &#8220;size&#8221; and &#8220;importance&#8221; in its 
  Priority field values. Their meaning is roughly:
             <ol>
               <li>Blocker: pointless to release without this change as the release would be unusable 
-  to a large minority of users</li>
+  to a large minority of users. Correctness and data loss issues should be considered Blockers.</li>
               <li>Critical: a large minority of users are missing important functionality without 
   this, and/or a workaround is difficult</li>
               <li>Major: a small minority of users are missing important functionality without this, 
@@ -480,6 +481,20 @@ Example: <code>Fix typos in Foo scaladoc</code></li>
           <li><strong>Component</strong></li>
           <li><strong>Affects Version</strong>. For Bugs, assign at least one version that is known to exhibit the 
  problem or need the change</li>
+          <li><strong>Label</strong>. Not widely used, except for the following:
+            <ul>
+              <li><code>correctness</code>: a correctness issue</li>
+              <li><code>data-loss</code>: a data loss issue</li>
+              <li><code>release-notes</code>: the change&#8217;s effects need mention in release notes. The JIRA or pull request
+  should include detail suitable for inclusion in release notes &#8211; see &#8220;Docs Text&#8221; below.</li>
+              <li><code>starter</code>: small, simple change suitable for new contributors</li>
+            </ul>
+          </li>
+          <li><strong>Docs Text</strong>: For issues that require an entry in the release notes, this should contain the
+ information that the release manager should include in Release Notes. This should include a short summary
+ of what behavior is impacted, and detail on what behavior changed. It can be provisionally filled out
+ when the JIRA is opened, but will likely need to be updated with final details when the issue is
+ resolved.</li>
         </ol>
       </li>
       <li>Do not set the following fields:

http://git-wip-us.apache.org/repos/asf/spark-website/blob/0bef7665/site/versioning-policy.html
----------------------------------------------------------------------
diff --git a/site/versioning-policy.html b/site/versioning-policy.html
index 08d251d..621389d 100644
--- a/site/versioning-policy.html
+++ b/site/versioning-policy.html
@@ -248,9 +248,8 @@ available APIs.</p>
 <h2>Release Cadence</h2>
 
 <p>In general, feature (&#8220;minor&#8221;) releases occur about every 6 months. Hence, Spark 2.3.0 would
-generally be released about 6 months after 2.2.0. Maintenance releases happen as needed.
-A minor release usually sees 1-2 maintenance releases in the 6 months following its first
-release. Major releases do not happen according to a fixed schedule.</p>
+generally be released about 6 months after 2.2.0. Maintenance releases happen as needed
+in between feature releases. Major releases do not happen according to a fixed schedule.</p>
 
 <h3>Spark 2.4 Release Window</h3>
 
@@ -281,6 +280,12 @@ release. Major releases do not happen according to a fixed schedule.</p>
   </tbody>
 </table>
 
+<h2>Maintenance Releases and EOL</h2>
+
+<p>Feature release branches will, generally, be maintained with bug fix releases for a period of 18 months. 
+For example, branch 2.1.x is no longer considered maintained as of July 2018, 18 months after the release 
+of 2.1.0 in December 2016. No more 2.1.x releases should be expected after that point, even for bug fixes.</p>
+
   </div>
 </div>
 

http://git-wip-us.apache.org/repos/asf/spark-website/blob/0bef7665/versioning-policy.md
----------------------------------------------------------------------
diff --git a/versioning-policy.md b/versioning-policy.md
index 60e0b82..de6f1e6 100644
--- a/versioning-policy.md
+++ b/versioning-policy.md
@@ -53,9 +53,8 @@ available APIs.
 <h2>Release Cadence</h2>
 
 In general, feature ("minor") releases occur about every 6 months. Hence, Spark 2.3.0 would
-generally be released about 6 months after 2.2.0. Maintenance releases happen as needed.
-A minor release usually sees 1-2 maintenance releases in the 6 months following its first
-release. Major releases do not happen according to a fixed schedule.
+generally be released about 6 months after 2.2.0. Maintenance releases happen as needed
+in between feature releases. Major releases do not happen according to a fixed schedule.
 
 <h3>Spark 2.4 Release Window</h3>
 
@@ -64,3 +63,9 @@ release. Major releases do not happen according to a fixed schedule.
 | Mid Aug 2018 || Code freeze. Release branch cut.|
 | Late Aug 2018 || QA period. Focus on bug fixes, tests, stability and docs. Generally, no new features merged.|
 | Early Sep 2018 || Release candidates (RC), voting, etc. until final release passes|
+
+<h2>Maintenance Releases and EOL</h2>
+
+Feature release branches will, generally, be maintained with bug fix releases for a period of 18 months. 
+For example, branch 2.1.x is no longer considered maintained as of July 2018, 18 months after the release 
+of 2.1.0 in December 2016. No more 2.1.x releases should be expected after that point, even for bug fixes.


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org