Add proposals index and resolve number collisions#95
Conversation
3fa98f5 to
d5a532d
Compare
|
If this PR is accepted, I'll update the PR titles of the existing proposals to carry their assigned numbers. |
|
|
||
| When creating a new proposal: | ||
|
|
||
| 1. Create your proposal PR with a temporary filename (e.g. `proposals/nnn-my-proposal.md`) based on the [template](./000-template.md). |
| 3. Once the REAME PRs is merged, rename your proposal file to use the allocated number | ||
| 4. When your proposal is approved and about to to be merged: | ||
| - Move your proposal from the "Open Proposals" table to the "Accepted Proposals" table | ||
| - Update the link to point to the merged file instead of the PR |
There was a problem hiding this comment.
add "you may make this change in the PR of your proposal itself, as a separate commit. A separate PR is also fine".
| - Allocate your proposal the next sequential number | ||
| - Add an entry in the "Open Proposals" table below | ||
| - Link to your proposal PR | ||
| - Announce your proposal on the mailing list (https://kroxylicious.io/join-us/mailing-lists/) |
|
|
||
| Proposals are numbered in chronological order by PR creation date. | ||
|
|
||
| ⚠️ **Note:** Some proposals have number collisions with accepted proposals and need to be renumbered: |
There was a problem hiding this comment.
If this PR is accepted, I'll update the PR titles to carry the new numbers.
|
was wondering whether using PR number might be nicer. They'll still be chronological but then reffing #92 would also refer to proposal number 92. |
I think that's quite appealing, actually.
A couple of other things give me pause with our current model (which are not addressed by this proposal, I just wanted to get them out there, and this feels like an opportunity to do so):
|
I like this idea. It might be neater to have a separate proposals repo |
I think an index is worth having if it's cheap to maintain — and a GitHub Action that generates
Strongly agree. I think we should merge rejected proposals with a clear "rejected" status
I think we should stick with a separate repo. Agents can be pointed at multiple repos, and keeping On @robobario's point about using PR numbers as proposal numbers — I like it in principle, but Either way, an auto-generated index would make the numbering scheme work without manual upkeep. |
|
I'm +1 to merging rejected proposals. We'd need our process to say that the proposal author updates the proposal with a summary why the proposal was rejected. We'd need a status on the proposal to reflect the fact that the proposal is rejected and a separate area on the summary page. I can put together a GitHub action to auto maintain an index page. We could probably have some automation to assign the next proposal number automatically (commenting on the PR), but this sounds like over engineering. |
You're missing my point: It's about discoverability. People need to know about the other repo in the first place, clone it, and point their agent at it. Those are all barriers which need not exist. And the loss accrues to the project, because when people don't overcomes those barriers their agent has less context and will likely produce a worse result.
You're assuming there is a point in time when it becomes clear that a proposal has been rejected, with obvious reasons why, and that when that occurs the proposal author will be motivated to actually be bothered to record the fact. I don't think any of those is actually true. It certainly seems to be the case for AK that:
So although I think it would be great if the project doesn't forget about the discussion of a proposal that's not accepted, I also don't think it's as simple as you're making out. It's not a only technical problem that just needs a little automation. It's as much a social problem. |
Discoverability (of open proposals) would also be hurt by mingling Public API proposals with the wild amount of PRs in the main repo. Maybe we could automatically sync the design repo contents on main push into a hidden directory of the
For now maybe we should put this problem to the side. Getting the workflow going for New + Accepted proposals and figuring out whether there is a Rejected flow later. |
That might be worthwhile: Having the accepted proposals in the main repo is documenting the architecture and addresses the discoverability point. Why does it need to be a hidden directory? |
This introduces a proposal index (README.md) for the proposals directory to solve the problem of colliding proposal numbers. Currently, multiple open PRs have chosen proposal numbers that conflict with already-merged proposals. This creates confusion and makes it difficult to maintain stable identifiers for proposals - which is essential for productive discussion on the mailing list. The new process: 1. Authors create proposals with temporary filenames (nnn-*) 2. A separate PR to this README allocates the next sequential number 3. Authors rename their proposal once the number is allocated 4. The index is updated again when proposals are accepted This ensures: - Proposal numbers are allocated chronologically - No number collisions occur - Each proposal gets a stable identifier before mailing list discussion - Clear visibility of open vs. accepted proposals Current collisions resolved by this index: - PR kroxylicious#70, kroxylicious#82, kroxylicious#83, kroxylicious#88, kroxylicious#89 all have numbers conflicting with accepted proposals and have been allocated new sequential numbers (016-024) Assisted-By: Claude Sonnet 4.5 <noreply@anthropic.com> Signed-off-by: Keith Wall <kwall@apache.org>
In order to make progress on the collision issue. I will do the following:
|
d5a532d to
030941f
Compare
0b46b70 to
48eec63
Compare
This change simplifies the proposal numbering system by using PR numbers as proposal identifiers, eliminating number collisions and removing the need for a separate allocation process. Changes: - Simplified proposals/README.md to focus on author workflow - Removed index tables (directory listing serves as the index) - Streamlined instructions for creating and renaming proposals - Updated proposal template with workflow instructions - Added GitHub workflow to automatically check proposal numbering - Updates PR description when proposal files don't match PR number - Provides exact commands to fix naming issues - Removes warning once corrected - Added notification script for existing open PRs - After merge, run notify-open-prs.sh to ask authors to rebase - Workflow will automatically guide them through renaming Proposals 001-019 retain their original numbers. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
48eec63 to
5a06b57
Compare
|
Closing in favor of #104 which has a cleaner implementation focused on automation. |
Summary
This PR introduces a proposal index (
proposals/README.md) to solve the problem of colliding proposal numbers and establish a clear process for allocating proposal numbers.Problem
Currently, multiple open proposal PRs have chosen numbers that conflict with already-merged proposals:
nnn-orxxx-This creates confusion and makes it difficult to maintain stable identifiers for proposals. When we discuss proposals on the mailing list, we need a consistent way to reference them throughout the discussion period, not just after they're merged.
Solution
This PR adds:
A proposal index (
proposals/README.md) that lists:A defined process for proposal authors:
nnn-my-proposal.md)Chronological numbering of open proposals to resolve collisions:
Benefits
🤖 Assisted-By: Claude Sonnet 4.5