APEs are documents to address non-trivial enhancements that require discussion and thought beyond a single Pull Request. This is intended to mirror the long-standing PEP (Python Enhancement Proposal) process, but generally not quite as formally. Please consult APE Purpose and Process for full details.
Please read the "Submitting an APE" section in APE Purpose and Process.
Tips:
- Don't forget to check the open PRs when finding the next free number for your APE.
- For your PR description, usually it's the easiest to paste in the abstract, and link to other existing GitHub Issues or PRs, if applicable.
Please read the "APE Review" section in APE Purpose and Process.
If the APE was accepted, here are the archiving (Zenodo) instructions for the Coordination Committee:
Upload the APE to Zenodo to give it a DOI. Log into the astropy team Zenodo account (not your personal account), go to https://zenodo.org/deposit/new, upload the RST file, and set the fields to the following:
Zenodo field
Set to
Communities
The Astropy Project
Upload type
Publication
Publication type
Technical note
Publication Date
The date-last-revised of the APE (which should be the same as the accepted date for new APEs)
Title
Astropy Proposal for Enhancement <number>: <title> (APE <number>)
Authors
The APE authors (directly from the APE text, but with ORCIDs if possible)
Description
The APE abstract (copy/paste the rendered HTML from GitHub)
License
CC-Attribution (default)
Related/alternate identifiers
GitHub link to the APE file at the specific merge commit (e.g. https://github.com/astropy/astropy-APEs/blob/42951733ac42c0ea178d8df30705274a43c93091/APE1.rst) as "is supplemented by this upload". If this is a revised version, this should be the URL of the commit where the APE was revised.
Get the source for the DOI badge from the newly-created Zenodo record page by clicking on the DOI badge on the right side of the page and copying the reStructuredText source. You will need to update that with the "all versions" DOI number, which you can see under the "versions" section of Zenodo. (It is typically the first version minus 1.)
(This step can be done directly on main or as a PR, as you prefer.) Edit README.rst to add the DOI link from the previous step to the relevant row for the APE in the "APEs" table. Preview the update and test the link to make sure they are all correct. Then, commit the change.
Please read the "Modifications to an existing APE" section in APE Purpose and Process.
If applicable, the Zenodo entry needs to be updated with a new version of the APE (not a completely new Zenodo entry), by using the "New version" button and then filling out the forms as described in "Finalizing APEs" section above.