Skip to content

Commit

Permalink
[core] Add RFC GH issue template (#33871)
Browse files Browse the repository at this point in the history
* [docs] Add RFC GH issue template

* Update .github/ISSUE_TEMPLATE/3.rfc.yml

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/3.rfc.yml

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/3.rfc.yml

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/3.rfc.yml

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/3.rfc.yml

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/3.rfc.yml

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/3.rfc.yml

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>

* Update .github/ISSUE_TEMPLATE/3.rfc.yml

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>

* Remove redundant duplication in RFC

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
  • Loading branch information
bytasv and samuelsycamore committed Sep 9, 2022
1 parent 6a9ec13 commit adda22c
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/3.rfc.yml
@@ -0,0 +1,42 @@
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: Write a short paragraph or bulleted list to briefly explain what you're trying to do, what outcomes you're aiming for, and any other relevant details to help us understand the 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 alternative options for achieving your desired outcome? It's not necessary to go into too much detail here, but it can help strengthen your main proposal.
- type: textarea
attributes:
label: Proposed solution 🟢
description: |
This is the core of the RFC. Please clearly explain the reasoning behind your proposed solution, including why it would be preferred over possible alternatives.
Consider:
- using diagrams to help illustrate your ideas
- including code examples if you're proposing an interface or system contract
- linking to relevant project briefs or wireframes
- type: textarea
attributes:
label: Resources and benchmarks 🔗
description: Attach any issues, PRs, links, documents, etc… that might be relevant to the RFC

0 comments on commit adda22c

Please sign in to comment.