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

Add a proposal template #47

Merged
merged 3 commits into from
Dec 7, 2023

Conversation

matthewp
Copy link
Contributor

@matthewp matthewp commented Nov 8, 2023

Currently there is no suggestion given to the format of a proposal. This has led to proposals that are inconsistent with other and previous proposals. Additionally some proposals have omitted explicit Goals which makes it difficult to understand what the proposal is doing and why.

This adds a proposal template to the repo that acts as a starting point. We can discuss which sections should be required or if some should be added.

Copy link
Collaborator

@Westbrook Westbrook left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea!

Would it make sense to sense to include a “Open Questions / Previous considerations” section as per #42?

proposal-template.md Show resolved Hide resolved
@@ -6,7 +6,7 @@ Think of things like a context API, async work (Suspense-like), SSR-interop, inc

## Get involved

Check out the [Issues](https://github.com/webcomponents/community-protocols/issues) and [PRs](https://github.com/webcomponents/community-protocols/pulls) currently open on this repo to join in on conversations already inflight regarding a number of exciting areas. If you have ideas on a protocol you like raised to the community open a new [issues](https://github.com/webcomponents/community-protocols/issues/new) so that authors and consumers of libraries and components from across the community that likely have (or wanted to have) implemented features in that area can join in with their use cases as well. Once the rough edges have been hammered out, submit a PR with specs of the protocol and append it to the "Protocols" list below so it can be formalized and put into use across the community.
Check out the [Issues](https://github.com/webcomponents/community-protocols/issues) and [PRs](https://github.com/webcomponents/community-protocols/pulls) currently open on this repo to join in on conversations already inflight regarding a number of exciting areas. If you have ideas on a protocol you like raised to the community open a new [issues](https://github.com/webcomponents/community-protocols/issues/new) so that authors and consumers of libraries and components from across the community that likely have (or wanted to have) implemented features in that area can join in with their use cases as well. Once the rough edges have been hammered out, submit a PR (pull-request) with specs of the protocol and append it to the "Protocols" list below so it can be formalized and put into use across the community. Use this [template](./proposal-template.md) for your proposals PRs.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Check out the [Issues](https://github.com/webcomponents/community-protocols/issues) and [PRs](https://github.com/webcomponents/community-protocols/pulls) currently open on this repo to join in on conversations already inflight regarding a number of exciting areas. If you have ideas on a protocol you like raised to the community open a new [issues](https://github.com/webcomponents/community-protocols/issues/new) so that authors and consumers of libraries and components from across the community that likely have (or wanted to have) implemented features in that area can join in with their use cases as well. Once the rough edges have been hammered out, submit a PR (pull-request) with specs of the protocol and append it to the "Protocols" list below so it can be formalized and put into use across the community. Use this [template](./proposal-template.md) for your proposals PRs.
Check out the [Issues](https://github.com/webcomponents/community-protocols/issues) and [PRs](https://github.com/webcomponents/community-protocols/pulls) currently open on this repo to join in on conversations already inflight regarding a number of exciting areas. If you have ideas on a protocol you'd like raised to the community, open a new [issue](https://github.com/webcomponents/community-protocols/issues/new) so that authors and consumers of libraries and components from across the community who likely have (or wanted to have) implemented features in that area can join in with their use cases as well. Once the rough edges have been hammered out, submit a PR (pull-request) with specs of the protocol and append it to the "Protocols" list below so it can be formalized and put into use across the community. Use this [template](./proposal-template.md) for your proposal's PRs.

Just some minor copyedits.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you submit this as a new PR? Looks like it was merged before these could be accepted.

@Westbrook Westbrook merged commit 0fa0d47 into webcomponents-cg:main Dec 7, 2023
@matthewp matthewp deleted the proposal-template branch December 8, 2023 01:02
nolanlawson added a commit to nolanlawson/community-protocols that referenced this pull request Dec 8, 2023
Follow-up to webcomponents-cg#47, just some small copyedits.
@mattlucock
Copy link

@matthewp Sorry to bring up an issue just after this has been merged, but I'm actively contemplating using the template, and I'm a little unsure about the ordering of the sections. Having the examples section immediately follow the summary section at the beginning of a proposal feels strange to me, since it seems like the examples are necessarily going to illustrate concepts that have not yet been introduced or explained, which seems like it would be quite confusing for the reader. What was your rationale for having it at the beginning? I feel like the examples would most logically follow after the design detail section.

@matthewp
Copy link
Contributor Author

@mattlucock I mostly copied from RFC templates in existing OS projects. I think the ordering here makes sense, the Design detail section can be pretty verbose, maybe even being a step-by-step of how the thing should be implemented. Seeing such details before you have an idea of the shape of the API can be difficult. For me at least, seeing an example is enough to understand what the API is doing. The details then explain, well, the details.

Of course the template is just a template and if you feel your proposal should be ordered differently you are able to do so. It's not a rule that it be ordered this way.

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.

None yet

5 participants