From 9c2a2e54d285d8ddfec9a05591ad95d9cbd435b1 Mon Sep 17 00:00:00 2001 From: Matthew Phillips Date: Tue, 7 Nov 2023 19:04:29 -0500 Subject: [PATCH 1/3] Add a proposal template --- proposal-template.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 proposal-template.md diff --git a/proposal-template.md b/proposal-template.md new file mode 100644 index 0000000..a9a0a66 --- /dev/null +++ b/proposal-template.md @@ -0,0 +1,31 @@ +# Proposal name + +**Author**: Name here + +**Status**: Draft + +**Last updated**: Date here + +# Summary + +A brief, one or two sentence explanation of the proposal. + +# Example + +Provide an example of the API using type definitions and/or code exmaple. + +# Goals + +- Write an explicit list. +- Of what this proposal hopes to achieve. +- Be as specific and broad as possible. + +# Non-goals + +- It's also important to be explicit about non-goals. +- This prevents feature creep and tangent conversations. +- Both goals and non-goals are valid topics to debate and can make/break the proposal. + +# Design detail + +Go into detail on the design of the API, This is where you go past the surface and explain the mechanics of how the API works. If a step-by-step direction is possible, provide it. \ No newline at end of file From 46b42e76da9bb9dc8eef71e77ce62fcc28a9cd2d Mon Sep 17 00:00:00 2001 From: Matthew Phillips Date: Tue, 7 Nov 2023 19:30:12 -0500 Subject: [PATCH 2/3] Update based on feedback --- proposal-template.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/proposal-template.md b/proposal-template.md index a9a0a66..6ccdfea 100644 --- a/proposal-template.md +++ b/proposal-template.md @@ -4,6 +4,8 @@ **Status**: Draft +**Created**: Date here + **Last updated**: Date here # Summary @@ -12,7 +14,7 @@ A brief, one or two sentence explanation of the proposal. # Example -Provide an example of the API using type definitions and/or code exmaple. +Provide an example of the API using type definitions and/or code example. # Goals @@ -28,4 +30,12 @@ Provide an example of the API using type definitions and/or code exmaple. # Design detail -Go into detail on the design of the API, This is where you go past the surface and explain the mechanics of how the API works. If a step-by-step direction is possible, provide it. \ No newline at end of file +Go into detail on the design of the API, This is where you go past the surface and explain the mechanics of how the API works. If a step-by-step direction is possible, provide it. + +# Open questions + +The first draft of any proposal is not going to have all of the answers. Take this space to be clear of what is still unknown. + +# Previous considerations + +List any previous proposals or priority art that inspired this proposal. \ No newline at end of file From 4800ff3e06bb3912f9e50e13e7a11517d9f1b756 Mon Sep 17 00:00:00 2001 From: Matthew Phillips Date: Tue, 7 Nov 2023 19:31:10 -0500 Subject: [PATCH 3/3] Add links in the readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3a0abf6..dada1e0 100644 --- a/README.md +++ b/README.md @@ -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. ## Proposals