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 RFC template #729

Merged
merged 6 commits into from
Aug 9, 2022
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/3.rfc.yml
Original file line number Diff line number Diff line change
@@ -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 🟢
bytasv marked this conversation as resolved.
Show resolved Hide resolved
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/benchmarks 🔗
description: Attach any issues, PRs, links, documents, etc… that might be relevant to the RFC