You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/api-change-proposal.md
+18-6Lines changed: 18 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -10,19 +10,31 @@ assignees: ""
10
10
11
11
## Problem statement
12
12
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. -->
14
14
15
-
## Motivation, use-cases
15
+
## Motivating examples or usecases
16
16
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. -->
18
18
19
-
## Solution sketches
19
+
## Solution sketch
20
20
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
+
-->
22
34
23
35
## Links and related work
24
36
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. -->
0 commit comments