aboutsummaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE/rfc.md
blob: 8938c65333d91b47cc8529dab6daaba6c854ad7d (about) (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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?