APE 1: Proposal filename should be descriptive (naming chaos fix 1) #96
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation: Asking people to put a number in APE proposal filename too early and then changing the number last minute can cause merge conflict (for another open APE proposal) and confusion (for everyone else).
Case study:
But why are we renaming? To prevent gaps in accepted APE listing (e.g., the still open #14 and the missing APE 11 in the list of accepted APEs).
Proposed solution: Update APE 1 to ask APE proposal authors to not use a number at all. Now, the numbering will only be assigned at merge time by a CoCo member doing the merge.
Pros: No more numbering confusion or gaps.
Cons: Renaming a file last minute makes for ugly commit history and weird
git blame
. Also cannot say "APE short-number" in discussions until after it is accepted.Alternative:
More discussion: https://groups.google.com/g/astropy-dev/c/7Tnx7S3aGP4