Create issue template for RFCs (#1234)

* github: update label directive in issue templates

Signed-off-by: Harsh Shandilya <me@msfjarvis.dev>

* github: add an issue template for RFCs

Signed-off-by: Harsh Shandilya <me@msfjarvis.dev>
This commit is contained in:
Harsh Shandilya 2020-12-04 19:42:31 +05:30 committed by GitHub
parent 6a6201f2ed
commit 8eb55f18a1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 43 additions and 6 deletions

View file

@ -2,9 +2,7 @@
name: Bug report
about: Create a report to help us address issues you are facing with the app
title: "[BUG]"
labels: 'bug, triage: needed'
assignees: ''
labels: 'C-bug, S-awaiting-triage'
---
<!--

View file

@ -2,9 +2,7 @@
name: Feature request
about: Suggest a new feature to be included in the app
title: "[FEATURE]"
labels: 'feature, triage: needed'
assignees: 'msfjarvis'
labels: 'C-feature, S-awaiting-triage'
---
<!--

41
.github/ISSUE_TEMPLATE/rfc.md vendored Normal file
View file

@ -0,0 +1,41 @@
---
name: RFC
about: Proposal for any major/breaking changes that warrants discussion over design and other aspects. Users should not need to use this.
title: "[RFC]"
labels: 'C-rfc, S-waiting-for-comment'
---
# Summary
[summary]: #summary
One paragraph explanation of the feature.
# Motivation
[motivation]: #motivation
Why are we doing this? What use cases does it support? What is the expected outcome?
# Drawbacks
[drawbacks]: #drawbacks
Why should we *not* do this?
# Rationale and alternatives
[rationale-and-alternatives]: #rationale-and-alternatives
- Why is this design the best in the space of possible designs?
- What other designs have been considered and what is the rationale for not choosing them?
- What is the impact of not doing this?
# Prior art
[prior-art]: #prior-art
Discuss prior art, both the good and the bad, in relation to this proposal. This can include
any other projects that have implemented similar changes, or any previous discussions that
have happened around this within the scope of this project.
# Unresolved questions
[unresolved-questions]: #unresolved-questions
- What parts of the design do you expect to resolve through the RFC process before this gets merged?
- What related issues do you consider out of scope for this RFC that could be addressed in the future independently of the solution that comes out of this RFC?