From 5b38502fbb3e74417f40b276d58cfd505ebfc275 Mon Sep 17 00:00:00 2001 From: "P. L. Lim" <2090236+pllim@users.noreply.github.com> Date: Mon, 5 Feb 2024 14:08:38 -0500 Subject: [PATCH 1/2] APE 1: Proposal filename should be descriptive --- APE1.rst | 19 +++++++++++++------ README.rst | 8 ++++---- 2 files changed, 17 insertions(+), 10 deletions(-) diff --git a/APE1.rst b/APE1.rst index 3d7c718d..51b99d6d 100644 --- a/APE1.rst +++ b/APE1.rst @@ -1,11 +1,11 @@ APE Purpose and Process ----------------------- -author: Perry Greenfield +author: Perry Greenfield, Lia Corrales, Thomas Robitaille, Erik Tollerud, Pey Lian Lim date-created: 2013 October 11 -date-last-revised: 2021 February 26 +date-last-revised: 2024 February 5 date-accepted: 2013 November 8 @@ -13,7 +13,10 @@ type: Process status: Accepted -revised-by: Lia Corrales, Thomas Robitaille, Erik Tollerud - 2021 February 26 - Added APE modification process +revised-by: + +* Lia Corrales, Thomas Robitaille, Erik Tollerud - 2021 February 26 - Added APE modification process +* Pey Lian Lim - 2024 February 5 - Added APE numbering process Abstract -------- @@ -83,8 +86,11 @@ 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 -appropriately assigned number. The draft must use the APEtemplate.rst file. +pull request to astropy-APEs with the name .rst where is a +concise short description of its purpose. At the time of acceptance, .rst +would be renamed to APE.rst by the CoCo member doing the PR merge, where +is the next available number in the listing of accepted APEs. +The draft must follow the APEtemplate.rst file. That a formal proposal has been submitted as a PR should be announced to the astropy-dev list. @@ -191,4 +197,5 @@ 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 `_] +* 2021-03-09 [`GitHub `_] diff --git a/README.rst b/README.rst index f9a5eeb9..0768f167 100644 --- a/README.rst +++ b/README.rst @@ -148,17 +148,17 @@ Finalizing APEs ^^^^^^^^^^^^^^^ The final decision on accepting or rejecting APEs lies with the Astropy -Coordination Committee. Once the community discussion on the APE has wound +Coordination Committee (CoCo). Once the community discussion on the APE has wound down, the committee discusses the APE and makes a final decision on acceptance or rejection. One of the committee members should then: +#. Rename the APE file to be ``APE##.rst``, where ## is the next + free number on the list of accepted APEs. #. Fill in the "Decision rationale" section of the APE with a description of why the APE was accepted or rejected, including a summary of the community's discussion as relevant. #. Update the "date-last-revised" to the day of merging and "status" to "Accepted" or "Rejected". -#. If necessary, rename the APE file to be ``APE##.rst``, where ## is the next - free number on the list of APEs. #. Leave a brief comment in the PR indicating the result. #. Merge the PR with the above changes. #. If the APE was accepted then continue with the remaining steps, otherwise @@ -198,7 +198,7 @@ or rejection. One of the committee members should then: Updating APEs ^^^^^^^^^^^^^ -In the cases where an updated APE requires updating (e.g. references to a new +In the cases where an updated APE requires updating (e.g., references to a new APE that supercedes it, clarifying information that emerges after the APE is accepted, etc.), changes can be made directly via PR, but the "date-last-revised" should be updated in the APE. Additionally, the Zenodo entry From c1ee736113b72bac222178c27286e083116aa1b4 Mon Sep 17 00:00:00 2001 From: "P. L. Lim" <2090236+pllim@users.noreply.github.com> Date: Mon, 5 Feb 2024 14:40:32 -0500 Subject: [PATCH 2/2] Dial it back down from 11 --- APE1.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/APE1.rst b/APE1.rst index 51b99d6d..8db331b2 100644 --- a/APE1.rst +++ b/APE1.rst @@ -1,7 +1,7 @@ APE Purpose and Process ----------------------- -author: Perry Greenfield, Lia Corrales, Thomas Robitaille, Erik Tollerud, Pey Lian Lim +author: Perry Greenfield date-created: 2013 October 11 @@ -90,7 +90,7 @@ pull request to astropy-APEs with the name .rst where concise short description of its purpose. At the time of acceptance, .rst would be renamed to APE.rst by the CoCo member doing the PR merge, where is the next available number in the listing of accepted APEs. -The draft must follow the APEtemplate.rst file. +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.