Skip to content

Commit 2ea3731

Browse files
committed
0000-template.md: Encourage discussion of maintenance
Add some points to encourage RFCs to discuss how a proposal impacts the ease of reading, understanding, and maintaining Rust code, not just the ease of writing it.
1 parent 05b989a commit 2ea3731

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

0000-template.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Explain the proposal as if it was already included in the language and you were
2323
- Explaining how Rust programmers should *think* about the feature, and how it should impact the way they use Rust. It should explain the impact as concretely as possible.
2424
- If applicable, provide sample error messages, deprecation warnings, or migration guidance.
2525
- If applicable, describe the differences between teaching this to existing Rust programmers and new Rust programmers.
26+
- Discuss how this impacts the ability to read, understand, and maintain Rust code. Code is read and modified far more often than written; how will the proposed feature make code easier to maintain?
2627

2728
For implementation-oriented RFCs (e.g. for compiler internals), this section should focus on how compiler contributors should think about the change, and give examples of its concrete impact. For policy RFCs, this section should provide an example-driven introduction to the policy, and explain its impact in concrete terms.
2829

@@ -48,6 +49,7 @@ Why should we *not* do this?
4849
- Why is this design the best in the space of possible designs?
4950
- What other designs have been considered and what is the rationale for not choosing them?
5051
- What is the impact of not doing this?
52+
- If this is a language proposal, could this be done in a library or macro instead? Does the proposed change make Rust code easier or harder to read, understand, and maintain?
5153

5254
# Prior art
5355
[prior-art]: #prior-art

0 commit comments

Comments
 (0)