From 7399560db681150513a71db564ed63649813e25f Mon Sep 17 00:00:00 2001 From: eblur Date: Thu, 2 Jul 2020 12:00:29 -0400 Subject: [PATCH 01/10] Seeking comments for language to this APE update First draft ready for discussion on astropy-dev Encourage labeling major changes in APE text --- APE1.rst | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/APE1.rst b/APE1.rst index 50844367..3ffdf244 100644 --- a/APE1.rst +++ b/APE1.rst @@ -1,11 +1,11 @@ APE Purpose and Process ----------------------- -author: Perry Greenfield +author: Perry Greenfield, Lia Corrales date-created: 2013 October 11 -date-last-revised: 2013 November 8 +date-last-revised: 2020 July date-accepted: 2013 November 8 @@ -139,6 +139,28 @@ An APE's status can rationales, so that new community members can understand why a decision was made. +Modifications to an APE +....................... + +**Addendum: July 2020** + +An APE can be modified, with one person acting as "champion" for the +APE update. Similar to the APE development procedure, the update +champion should discuss their desired changes with the astropy +community (e.g., through the astropy-dev mailing list). + +Following a discussion on astropy-dev, the APE update shall be +submitted as a Pull Request. The submission of the Pull Request should +be announced formally on the astropy-dev list before they are +accepted. If not already listed, the update champion can add +themselves to the author list for the APE being updated. When +appropriate, major changes to an APE document are encouraged to be +clearly labeled as an addendum. + +The Astropy Coordinating Committee is responsible for reviewing and +ultimately accepting Pull Requests for changes to individual APEs, +unless otherwise specified within the APE document of interest. + Branches and Pull requests -------------------------- From 9a677c0fab22f4753ca1bc9b07b61bc7a89a0a0a Mon Sep 17 00:00:00 2001 From: eblur Date: Wed, 22 Jul 2020 13:38:50 -0400 Subject: [PATCH 02/10] Ready for pull request after incorporating feedback --- APE1.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/APE1.rst b/APE1.rst index 3ffdf244..677688bc 100644 --- a/APE1.rst +++ b/APE1.rst @@ -5,7 +5,7 @@ author: Perry Greenfield, Lia Corrales date-created: 2013 October 11 -date-last-revised: 2020 July +date-last-revised: 2020 July 22 date-accepted: 2013 November 8 @@ -142,7 +142,7 @@ An APE's status can Modifications to an APE ....................... -**Addendum: July 2020** +**Addendum: July 22, 2020** An APE can be modified, with one person acting as "champion" for the APE update. Similar to the APE development procedure, the update From bd65cf05d1ba260e6b7f4a84614ba0895a31ab25 Mon Sep 17 00:00:00 2001 From: Lia Corrales Date: Wed, 29 Jul 2020 10:33:47 -0400 Subject: [PATCH 03/10] Update APE1.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Brigitta Sipőcz --- APE1.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/APE1.rst b/APE1.rst index 677688bc..f00c17be 100644 --- a/APE1.rst +++ b/APE1.rst @@ -146,7 +146,7 @@ Modifications to an APE An APE can be modified, with one person acting as "champion" for the APE update. Similar to the APE development procedure, the update -champion should discuss their desired changes with the astropy +champion should discuss their desired changes with the Astropy community (e.g., through the astropy-dev mailing list). Following a discussion on astropy-dev, the APE update shall be From a4e55d2265f0d0f36f7319d5b16317c9990dee79 Mon Sep 17 00:00:00 2001 From: Thomas Robitaille Date: Fri, 26 Feb 2021 14:12:48 +0000 Subject: [PATCH 04/10] Update section/process for modifying APEs --- APE1.rst | 39 +++++++++++++++++++++------------------ 1 file changed, 21 insertions(+), 18 deletions(-) diff --git a/APE1.rst b/APE1.rst index f00c17be..ede7ced8 100644 --- a/APE1.rst +++ b/APE1.rst @@ -1,11 +1,11 @@ APE Purpose and Process ----------------------- -author: Perry Greenfield, Lia Corrales +author: Perry Greenfield, Lia Corrales, Thomas Robitaille date-created: 2013 October 11 -date-last-revised: 2020 July 22 +date-last-revised: 2021 February 26 date-accepted: 2013 November 8 @@ -142,24 +142,22 @@ An APE's status can Modifications to an APE ....................... -**Addendum: July 22, 2020** +An APE can be modified, with one person acting as "champion" for the APE update. +Similar to the APE development procedure, the update champion should discuss +their desired changes with the Astropy community (e.g., through the astropy-dev +mailing list). Following a discussion on astropy-dev, the APE update should be +submitted as a Pull Request which should be advertised on astropy-dev. -An APE can be modified, with one person acting as "champion" for the -APE update. Similar to the APE development procedure, the update -champion should discuss their desired changes with the Astropy -community (e.g., through the astropy-dev mailing list). +The APE should be modified directly without annotating the changes. If not +already listed, the update champion can add themselves to the author list for +the APE being updated. A new section, **Previous versions of this APE** should +be added to the bottom of the APE (if not already there) with a bullet point +list of dates which link to the DOI of the previous versions of APEs. -Following a discussion on astropy-dev, the APE update shall be -submitted as a Pull Request. The submission of the Pull Request should -be announced formally on the astropy-dev list before they are -accepted. If not already listed, the update champion can add -themselves to the author list for the APE being updated. When -appropriate, major changes to an APE document are encouraged to be -clearly labeled as an addendum. - -The Astropy Coordinating Committee is responsible for reviewing and -ultimately accepting Pull Requests for changes to individual APEs, -unless otherwise specified within the APE document of interest. +The Astropy Coordinating Committee is responsible for reviewing and ultimately +accepting Pull Requests for changes to individual APEs, unless otherwise +specified within the APE document of interest. For non-trivial changes, +community consensus should generally be reached before acceptance. Branches and Pull requests -------------------------- @@ -185,3 +183,8 @@ Decision Rationale ------------------ The coordinating committee thought it was a honking great idea. + +Previous versions of this APE +----------------------------- + +* `2013-11-08 `_ \ No newline at end of file From 1b48eb669fee6f4f97960996c75c86baa7bd9d69 Mon Sep 17 00:00:00 2001 From: Thomas Robitaille Date: Fri, 26 Feb 2021 14:14:20 +0000 Subject: [PATCH 05/10] Don't capitalize pull request --- APE1.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/APE1.rst b/APE1.rst index ede7ced8..2c88da30 100644 --- a/APE1.rst +++ b/APE1.rst @@ -81,7 +81,7 @@ APE-able. Posting to the astropy-dev mailing list is the best way to go about doing this. Following a discussion on astropy-dev, the proposal should be submitted as a -Pull Request to astropy-APEs with the name APE.rst where is an +pull request to astropy-APEs with the name APE.rst where is an appropriately assigned number. The draft must use the APEtemplate.rst file. That a formal proposal has been submitted as a PR should be announced to the astropy-dev list. @@ -146,7 +146,7 @@ An APE can be modified, with one person acting as "champion" for the APE update. Similar to the APE development procedure, the update champion should discuss their desired changes with the Astropy community (e.g., through the astropy-dev mailing list). Following a discussion on astropy-dev, the APE update should be -submitted as a Pull Request which should be advertised on astropy-dev. +submitted as a pull request which should be advertised on astropy-dev. The APE should be modified directly without annotating the changes. If not already listed, the update champion can add themselves to the author list for @@ -155,11 +155,11 @@ be added to the bottom of the APE (if not already there) with a bullet point list of dates which link to the DOI of the previous versions of APEs. The Astropy Coordinating Committee is responsible for reviewing and ultimately -accepting Pull Requests for changes to individual APEs, unless otherwise +accepting pull requests for changes to individual APEs, unless otherwise specified within the APE document of interest. For non-trivial changes, community consensus should generally be reached before acceptance. -Branches and Pull requests +Branches and Pull Requests -------------------------- N/A From 7fa0d46184fee5add2124f2d95c6e6159a9cd17b Mon Sep 17 00:00:00 2001 From: Thomas Robitaille Date: Fri, 26 Feb 2021 14:54:48 +0000 Subject: [PATCH 06/10] Add GitHub link in previous versions --- APE1.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/APE1.rst b/APE1.rst index 2c88da30..e142054c 100644 --- a/APE1.rst +++ b/APE1.rst @@ -152,7 +152,8 @@ The APE should be modified directly without annotating the changes. If not already listed, the update champion can add themselves to the author list for the APE being updated. A new section, **Previous versions of this APE** should be added to the bottom of the APE (if not already there) with a bullet point -list of dates which link to the DOI of the previous versions of APEs. +list of dates which link to the DOI of the previous versions of APEs as well as +links to the merge commits of the APEs. The Astropy Coordinating Committee is responsible for reviewing and ultimately accepting pull requests for changes to individual APEs, unless otherwise @@ -187,4 +188,4 @@ The coordinating committee thought it was a honking great idea. Previous versions of this APE ----------------------------- -* `2013-11-08 `_ \ No newline at end of file +* 2013-11-08 [`DOI `_] [`GitHub `_] \ No newline at end of file From 1fae6b85a569668ad558a4debde510e1b10ca470 Mon Sep 17 00:00:00 2001 From: Thomas Robitaille Date: Fri, 26 Feb 2021 14:59:02 +0000 Subject: [PATCH 07/10] Fix DOI link --- APE1.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/APE1.rst b/APE1.rst index e142054c..c10e969a 100644 --- a/APE1.rst +++ b/APE1.rst @@ -188,4 +188,4 @@ The coordinating committee thought it was a honking great idea. Previous versions of this APE ----------------------------- -* 2013-11-08 [`DOI `_] [`GitHub `_] \ No newline at end of file +* 2013-11-08 [`DOI `_] [`GitHub `_] \ No newline at end of file From aa1dcc1b188296c52e3d81e1d4a1872246be085f Mon Sep 17 00:00:00 2001 From: Thomas Robitaille Date: Tue, 2 Mar 2021 11:53:09 +0000 Subject: [PATCH 08/10] Implement review suggestions --- APE1.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/APE1.rst b/APE1.rst index c10e969a..2bea070c 100644 --- a/APE1.rst +++ b/APE1.rst @@ -1,7 +1,7 @@ APE Purpose and Process ----------------------- -author: Perry Greenfield, Lia Corrales, Thomas Robitaille +author: Perry Greenfield date-created: 2013 October 11 @@ -13,6 +13,8 @@ type: Process status: Accepted +revised-by: Lia Corrales, Thomas Robitaille - 2021 February 26 - Added APE modification process + Abstract -------- @@ -142,7 +144,7 @@ An APE's status can Modifications to an APE ....................... -An APE can be modified, with one person acting as "champion" for the APE update. +An APE can be modified, with one person acting as champion for the APE update. Similar to the APE development procedure, the update champion should discuss their desired changes with the Astropy community (e.g., through the astropy-dev mailing list). Following a discussion on astropy-dev, the APE update should be @@ -155,10 +157,8 @@ be added to the bottom of the APE (if not already there) with a bullet point list of dates which link to the DOI of the previous versions of APEs as well as links to the merge commits of the APEs. -The Astropy Coordinating Committee is responsible for reviewing and ultimately -accepting pull requests for changes to individual APEs, unless otherwise -specified within the APE document of interest. For non-trivial changes, -community consensus should generally be reached before acceptance. +The review process is the same as for a newly-proposed APE as described in the +**APE Review** section above. Branches and Pull Requests -------------------------- From fdf8c40f607d85e540db4b7a4b93772b4f25377c Mon Sep 17 00:00:00 2001 From: Thomas Robitaille Date: Tue, 2 Mar 2021 11:57:19 +0000 Subject: [PATCH 09/10] Added description of revised-by --- APE1.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/APE1.rst b/APE1.rst index 2bea070c..1ac9e2db 100644 --- a/APE1.rst +++ b/APE1.rst @@ -155,7 +155,10 @@ already listed, the update champion can add themselves to the author list for the APE being updated. A new section, **Previous versions of this APE** should be added to the bottom of the APE (if not already there) with a bullet point list of dates which link to the DOI of the previous versions of APEs as well as -links to the merge commits of the APEs. +links to the merge commits of the APEs. The `date-last-revised` header for the APE +should be updated, and a `revised-by` header should be added for each +update (see the first `revised-by` section of *this* APE for a formatting +example). The review process is the same as for a newly-proposed APE as described in the **APE Review** section above. From ee3800a6eec6b11ce16c1c6633fa77c3d49a4418 Mon Sep 17 00:00:00 2001 From: Thomas Robitaille Date: Tue, 2 Mar 2021 11:57:52 +0000 Subject: [PATCH 10/10] Added Erik as a revision author --- APE1.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/APE1.rst b/APE1.rst index 1ac9e2db..3d7c718d 100644 --- a/APE1.rst +++ b/APE1.rst @@ -13,7 +13,7 @@ type: Process status: Accepted -revised-by: Lia Corrales, Thomas Robitaille - 2021 February 26 - Added APE modification process +revised-by: Lia Corrales, Thomas Robitaille, Erik Tollerud - 2021 February 26 - Added APE modification process Abstract --------