From b0f00f45585f70c59a4e7c58476389603a89ce22 Mon Sep 17 00:00:00 2001 From: bytasv Date: Wed, 3 Aug 2022 17:35:47 +0300 Subject: [PATCH 1/5] Add RFC template --- .github/ISSUE_TEMPLATE/3.rfc.yml | 41 ++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/3.rfc.yml diff --git a/.github/ISSUE_TEMPLATE/3.rfc.yml b/.github/ISSUE_TEMPLATE/3.rfc.yml new file mode 100644 index 00000000000..2a4526f176c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3.rfc.yml @@ -0,0 +1,41 @@ +name: RFC 💬 +description: Request for comments for your proposal. +title: "[RFC] " +labels: ['RFC'] +body: + - type: markdown + attributes: + value: | + Please provide a searchable summary of the RFC in the title above ⬆️. + + Thanks for contributing by creating an RFC! ❤️ + - type: textarea + attributes: + label: What's the problem? 🤔 + description: A short paragraph or bullet list that quickly explains what you're trying to do, what value do we expect to get or any other relevant information to understand motivation behind this RFC + + - type: textarea + attributes: + label: What are the requirements? ❓ + description: Provide a list of requirements that should be met by the accepted proposal + + - type: textarea + attributes: + label: What are our options? 💡 + description: Have you considered all options that we can achieve same/similar thing? It doesn't have to be explored in same detail as the main proposal, but having alternative options that you can present can help strengthen main proposal. + + - type: textarea + attributes: + label: Proposed option 🟢 + description: | + This is the core of RFC, and its purpose is to help you think through the problem because [writing is thinking](https://medium.learningbyshipping.com/writing-is-thinking-an-annotated-twitter-thread-2a75fe07fade).* + + Consider: + - using diagrams to help illustrate your ideas + - including code examples if you're proposing an interface or system contract + - linking to project briefs or wireframes that are relevant + + - type: textarea + attributes: + label: Relevant resources 🔗 + description: Attach any issues, PRs, links, documents, etc… that might be relevant to the RFC From ef6957dcf0d4cfc5186bf0ebf610ea869c15da59 Mon Sep 17 00:00:00 2001 From: Vytautas Butkus Date: Mon, 8 Aug 2022 17:04:33 +0300 Subject: [PATCH 2/5] Update .github/ISSUE_TEMPLATE/3.rfc.yml Co-authored-by: Marija Najdova Signed-off-by: Vytautas Butkus --- .github/ISSUE_TEMPLATE/3.rfc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/3.rfc.yml b/.github/ISSUE_TEMPLATE/3.rfc.yml index 2a4526f176c..60a0995fadb 100644 --- a/.github/ISSUE_TEMPLATE/3.rfc.yml +++ b/.github/ISSUE_TEMPLATE/3.rfc.yml @@ -37,5 +37,5 @@ body: - type: textarea attributes: - label: Relevant resources 🔗 + label: Relevant resources/benchmarks 🔗 description: Attach any issues, PRs, links, documents, etc… that might be relevant to the RFC From 0a028c3e8b0b4708b26dfd3765d276b7f9001271 Mon Sep 17 00:00:00 2001 From: Vytautas Butkus Date: Mon, 8 Aug 2022 17:15:46 +0300 Subject: [PATCH 3/5] Update .github/ISSUE_TEMPLATE/3.rfc.yml Co-authored-by: Marija Najdova Signed-off-by: Vytautas Butkus --- .github/ISSUE_TEMPLATE/3.rfc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/3.rfc.yml b/.github/ISSUE_TEMPLATE/3.rfc.yml index 60a0995fadb..b47b2807fa9 100644 --- a/.github/ISSUE_TEMPLATE/3.rfc.yml +++ b/.github/ISSUE_TEMPLATE/3.rfc.yml @@ -26,7 +26,7 @@ body: - type: textarea attributes: - label: Proposed option 🟢 + label: Proposed solution🟢 description: | This is the core of RFC, and its purpose is to help you think through the problem because [writing is thinking](https://medium.learningbyshipping.com/writing-is-thinking-an-annotated-twitter-thread-2a75fe07fade).* From 4e666bdd13fc617ef30904c6e02965fa88dc9ec3 Mon Sep 17 00:00:00 2001 From: bytasv Date: Mon, 8 Aug 2022 17:23:58 +0300 Subject: [PATCH 4/5] Add areas to consider for what are our options section --- .github/ISSUE_TEMPLATE/3.rfc.yml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/3.rfc.yml b/.github/ISSUE_TEMPLATE/3.rfc.yml index b47b2807fa9..b31e92e08ea 100644 --- a/.github/ISSUE_TEMPLATE/3.rfc.yml +++ b/.github/ISSUE_TEMPLATE/3.rfc.yml @@ -22,7 +22,13 @@ body: - type: textarea attributes: label: What are our options? 💡 - description: Have you considered all options that we can achieve same/similar thing? It doesn't have to be explored in same detail as the main proposal, but having alternative options that you can present can help strengthen main proposal. + description: | + Have you considered all options that we can achieve same/similar thing? It doesn't have to be explored in same detail as the main proposal, but having alternative options that you can present can help strengthen main proposal. + + Consider: + - using diagrams to help illustrate your ideas + - including code examples if you're proposing an interface or system contract + - linking to project briefs or wireframes that are relevant - type: textarea attributes: From 70137149eeda5524f69f0d9360844e1013271996 Mon Sep 17 00:00:00 2001 From: bytasv Date: Mon, 8 Aug 2022 18:38:10 +0300 Subject: [PATCH 5/5] Tweak proposed solution helper text --- .github/ISSUE_TEMPLATE/3.rfc.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/3.rfc.yml b/.github/ISSUE_TEMPLATE/3.rfc.yml index b31e92e08ea..59369f8f3a8 100644 --- a/.github/ISSUE_TEMPLATE/3.rfc.yml +++ b/.github/ISSUE_TEMPLATE/3.rfc.yml @@ -32,9 +32,9 @@ body: - type: textarea attributes: - label: Proposed solution🟢 + label: Proposed solution 🟢 description: | - This is the core of RFC, and its purpose is to help you think through the problem because [writing is thinking](https://medium.learningbyshipping.com/writing-is-thinking-an-annotated-twitter-thread-2a75fe07fade).* + This is the core of RFC, and its purpose is to clearly explain reasoning for the proposed solution, why it's better compared to the other options or why should it be chosen instead. Consider: - using diagrams to help illustrate your ideas