Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

APE 1: Proposal filename should be descriptive (naming chaos fix 1) #96

Closed
wants to merge 2 commits into from
Closed

APE 1: Proposal filename should be descriptive (naming chaos fix 1) #96

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b38502
APE 1: Proposal filename should be descriptive
pllim Feb 5, 2024
c1ee736
Dial it back down from 11
pllim Feb 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions APE1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
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

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
--------
Expand Down Expand Up @@ -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<n>.rst where <n> is an
appropriately assigned number. The draft must use the APEtemplate.rst file.
pull request to astropy-APEs with the name <description>.rst where <description> is a
concise short description of its purpose. At the time of acceptance, <description>.rst
would be renamed to APE<n>.rst by the CoCo member doing the PR merge, where <n>
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.

Expand Down Expand Up @@ -191,4 +197,5 @@ The coordinating committee thought it was a honking great idea.
Previous versions of this APE
-----------------------------

* 2013-11-08 [`DOI <http://doi.org/10.5281/zenodo.1043886>`_] [`GitHub <https://github.com/astropy/astropy-APEs/blob/42951733ac42c0ea178d8df30705274a43c93091/APE1.rst>`_]
* 2013-11-08 [`DOI <http://doi.org/10.5281/zenodo.1043886>`_] [`GitHub <https://github.com/astropy/astropy-APEs/blob/42951733ac42c0ea178d8df30705274a43c93091/APE1.rst>`_]
* 2021-03-09 [`GitHub <https://github.com/astropy/astropy-APEs/commit/f2afc2ec72575d3c592b3a5c6257117b07b5b755>`_]
8 changes: 4 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down