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

Improve the Proposal Template #501

Open
dan-odsc opened this issue May 9, 2024 · 2 comments
Open

Improve the Proposal Template #501

dan-odsc opened this issue May 9, 2024 · 2 comments
Assignees

Comments

@dan-odsc
Copy link
Contributor

dan-odsc commented May 9, 2024

Doc: https://docs.google.com/document/d/1Yc5D8RxeVF73nlkudSR3Hawg6prZAf2OTVOUrTQDnBY/edit#heading=h.kpn5fmmsrxfx

Suggestions from Devin:

@dan-odsc dan-odsc changed the title Improve the Version Upgrade Proposal Template Improve the Proposal Template May 16, 2024
@mrshll1001
Copy link
Contributor

Couldn't find the original forum post with Devin's suggestions, so putting reckons in here:

In short, this is much appreciated and helpful. We'll write a bit about making well-scoped proposals at the top of the template and after 3.1 we'll hopefully have some decent examples of proposals. Perhaps we can create a page somewhere on either the HSDS Docs or the OR site to list all the succesful proposals, so that there's always a recent example to hand?

Proposal scope is interesting. The answer to the question about what a proposal's scope should be is sadly a bit of a tautology; I think that we're going to see (and should see) proposals of different scopes. Long-term, I think it's the role of the technical committee to keep these proposals in scope through means of working with the proposal authors in producing the proposal, as well as rejecting proposals that try to do too much.

FWIW, if we think in software development terms I would see proposals as equivalent as a feature branch on a repo. They put forth some desired changes which are all necessary for implementing a particular feature of the standard; related fields, maybe some new structures etc. I would not expect them to have a strict 1-to-1 mapping to existing Issues on Github, but instead to cite issues (among other things) as evidence for the need of the proposed change(s). Similar to pull requests, we wouldn't want to accept a proposal that did too much or tried to change too much of the standard by itself; it's likely we'd work with the authors to try and break it up into piecemeal changes that the committee can better absorb and understand.

@dan-odsc
Copy link
Contributor Author

Perhaps we can create a page somewhere on either the HSDS Docs or the OR site to list all the successful proposals, so that there's always a recent example to hand?

Yes, great idea.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Ready
Development

No branches or pull requests

2 participants