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

proposal: require more information for proposals #70625

Open
seankhliao opened this issue Dec 1, 2024 · 1 comment
Open

proposal: require more information for proposals #70625

seankhliao opened this issue Dec 1, 2024 · 1 comment
Labels
Milestone

Comments

@seankhliao
Copy link
Member

Proposal Details

The current proposal process for non spec changes is fairly lightweight for the proposer: there is a text box labeled "Proposal Details".

This has led to quite a large number of proposals, at the time of filing: 743 open proposals marked incoming, with a total of 636 filed this year so far, averaging 1.89 per day.

A recurring pattern in proposals is that they lack the detail: they'll often just vaguely describe a desired change. This results in some repetitive back and forth as we try to narrow it down to a specific api change that can be evaluated, and surface the motivations for the proposal.

I propose a 3 field proposal form that covers the majority of proposals we see:

  • Proposal summary: in words, describe the proposal.
  • Motivation:
    • Describe why the change should be made
    • If this is already possible in a third party library, why it should be in the standard library
    • If this has previously been proposed and declined, what significant new information justified revisiting the decision.
    • Include references to external specs, code searches for frequent patterns, etc.
  • Change details:
    • For API changes, the desired new api in godoc format, including comments.
    • For behavioural changes, the updated godoc describing the new behaviour.

cc @golang/proposal-review

@gopherbot gopherbot added this to the Proposal milestone Dec 1, 2024
@seankhliao
Copy link
Member Author

I found an older related poposal #33670 but I think for that, the proposal committee already puts proposals on hold / asks for design docs?

@ianlancetaylor ianlancetaylor moved this to Incoming in Proposals Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Incoming
Development

No branches or pull requests

2 participants