-
-
Notifications
You must be signed in to change notification settings - Fork 32.4k
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
[core] Add RFC GH issue template #33871
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
69fd509
[docs] Add RFC GH issue template
bytasv cbe1403
Update .github/ISSUE_TEMPLATE/3.rfc.yml
bytasv 33ced89
Update .github/ISSUE_TEMPLATE/3.rfc.yml
bytasv f238522
Update .github/ISSUE_TEMPLATE/3.rfc.yml
bytasv 7bd5516
Update .github/ISSUE_TEMPLATE/3.rfc.yml
bytasv fbdcc36
Update .github/ISSUE_TEMPLATE/3.rfc.yml
bytasv 982ca2a
Update .github/ISSUE_TEMPLATE/3.rfc.yml
bytasv ed56cf3
Update .github/ISSUE_TEMPLATE/3.rfc.yml
bytasv fb03b8e
Update .github/ISSUE_TEMPLATE/3.rfc.yml
bytasv 4b1e9a7
Remove redundant duplication in RFC
bytasv File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could consider this as part of the problem statement that is above. At least, it's how it's currently done inside https://www.notion.so/mui-org/Shaping-33647d13ed534b838bde5bc8182eba18 (on this one, the idea was to have the template as open ended as possible).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd need to pull in the exact conversation but when we discussed this it was more about listing requirements in it's explicit section. For shaping items it might be less important, but since it's code related your might have certain constraints that you wanna list more often then not.
We could embed this into "problem statement" but I find having it in separate section is easier to find just by scanning 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's similar for non-code-related topics, e.g. https://www.notion.so/mui-org/Scale-collaborative-inbox-in-Google-Groups-f6f3d7a8a6bd4c24be1fc8b13a8f33f6#7d75b82e0525464c999d5bde5de6a6c2.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is indeed similar to what you show - but how would we formulate this explicitly in the problem statement? Do we expect that everyone will implicitly understand to list the requirements?
Should it simply just be "Requirements" subsection under problem statement?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It was what I was wondering about, maybe an opportunity to make the RFC template simpler 🤷♂️, e.g. https://github.com/reactjs/rfcs/blob/main/0000-template.md has no notions of requirements. But no real preferences.