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.

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

Conversation

pllim
Copy link
Member

@pllim pllim commented Feb 5, 2024

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

APE1.rst Outdated Show resolved Hide resolved
@bsipocz
Copy link
Member

bsipocz commented Feb 5, 2024

PEPs have gaps in them, NEPs, too (if you consider the deferred or under consideration numbers a gap), so I don't see why it would be a big issue to have gaps, IMO the renaming is more confusing.

@pllim
Copy link
Member Author

pllim commented Feb 5, 2024

Re: #96 (comment)

I agree. At the CoCo meeting today, this was discussed. I took on the action item to open 2 competing solutions (this and #97) and I will send out both to astropy-dev list for discussions.

@mhvk
Copy link
Contributor

mhvk commented Feb 5, 2024

Also see no problem with gaps, so downvoted this one and upvoted #97.

@pllim
Copy link
Member Author

pllim commented Mar 4, 2024

No support for this one, so closing.

@pllim pllim closed this Mar 4, 2024
@pllim pllim deleted the ape-proposal-descriptive branch March 4, 2024 17:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants