Skip to content

Commit 061d1f8

Browse files
committed
Updates to the API Change Proposal template
1 parent 866675f commit 061d1f8

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

.github/ISSUE_TEMPLATE/api-change-proposal.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,31 @@ assignees: ""
1010

1111
## Problem statement
1212

13-
<!-- Start with a concise description of the problem(s) this API change proposal is trying to solve. -->
13+
<!-- Start with a concise description of the problem you're trying to solve. Don't talk about possible solutions yet. -->
1414

15-
## Motivation, use-cases
15+
## Motivating examples or use cases
1616

17-
<!-- Next add any motivating examples. Examples should ideally be real world examples or minimized versions of the real world example in scenarios where the motivating code is not open source. -->
17+
<!-- Next add any motivating examples. Examples should ideally be real world examples, or minimized versions of the real world example in scenarios where the motivating code is not open source. -->
1818

19-
## Solution sketches
19+
## Solution sketch
2020

21-
<!-- Please also sketch out one or more solutions to the problem. For alternative solutions please also include any reasoning for why you didn't suggest those as the primary solution. You don't have to have all the details worked out, but it should be enough to convey the idea. -->
21+
<!--
22+
If you have a sketch of a concrete solution, please include it here. You don't have to have all the details worked out, but it should be enough to convey the idea.
23+
24+
If you want to smoke-test whether some solution to the problem would be acceptable, you can delete this section.
25+
-->
26+
27+
## Alternatives
28+
29+
<!--
30+
Please also discuss alternative solutions to the problem. Include any reasoning for why you didn't suggest those as the primary solution.
31+
32+
Could this be written using existing APIs? If so, roughly what would that look like? Why does it need to be different? Could this be done as a crate on crates.io?
33+
-->
2234

2335
## Links and related work
2436

25-
<!-- Provide links to any internal thread(s), github issues, related work from other languages, or other things that are worth following up on. -->
37+
<!-- Provide links to any <https://internals.rust-lang.org> thread(s), github issues, approaches to this problem in other languages/libraries, or similar supporting information. -->
2638

2739
## What happens now?
2840

0 commit comments

Comments
 (0)