Skip to content

Commit 87d399c

Browse files
authored
Merge pull request #224 from joshtriplett/change-proposal-improvements
Further improvements to the change proposal template
2 parents 9fb4538 + a86cd84 commit 87d399c

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

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

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ assignees: ""
1414

1515
## 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. Don't propose changes you think might *hypothetically* be useful; real use cases help make sure we have the right design. -->
1818

1919
## Solution sketch
2020

2121
<!--
2222
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.
2323
24-
If you want to smoke-test whether some solution to the problem would be acceptable, you can delete this section.
24+
If you want to quickly check whether *any* some solution to the problem would be acceptable, you can delete this section.
2525
-->
2626

2727
## Alternatives
@@ -41,3 +41,15 @@ Could this be written using existing APIs? If so, roughly what would that look l
4141
This issue is part of the libs-api team [API change proposal process]. Once this issue is filed the libs-api team will review open proposals as capability becomes available. Current response times do not have a clear estimate, but may be up to several months.
4242

4343
[API change proposal process]: https://std-dev-guide.rust-lang.org/feature-lifecycle/api-change-proposals.html
44+
45+
## Possible responses
46+
47+
The libs team may respond in various different ways. First, the team will consider the *problem* (this doesn't require any concrete solution or alternatives to have been proposed):
48+
49+
- We think this problem seems worth solving, and the standard library might be the right place to solve it.
50+
- We think that this probably doesn't belong in the standard library.
51+
52+
Second, if there's a concrete solution:
53+
54+
- We think this specific solution looks roughly right, approved, you or someone else should implement this. (Further review will still happen on the subsequent implementation PR.)
55+
- We're not sure this is the right solution, and the alternatives or other materials don't give us enough information to be sure about that. Here are some questions we have that aren't answered, or rough ideas about alternatives we'd want to see discussed.

0 commit comments

Comments
 (0)