From 2ea3731af1c07195745213fa78f5d2180d464770 Mon Sep 17 00:00:00 2001 From: Josh Triplett Date: Sun, 6 May 2018 14:11:23 -0700 Subject: [PATCH 1/2] 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. --- 0000-template.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/0000-template.md b/0000-template.md index 949a273de..85e8ad702 100644 --- a/0000-template.md +++ b/0000-template.md @@ -23,6 +23,7 @@ Explain the proposal as if it was already included in the language and you were - 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. - If applicable, provide sample error messages, deprecation warnings, or migration guidance. - If applicable, describe the differences between teaching this to existing Rust programmers and new Rust programmers. +- 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? 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. @@ -48,6 +49,7 @@ Why should we *not* do this? - 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? +- 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? # Prior art [prior-art]: #prior-art From 71e82bfb508e04eb7836285bbc49022465d4a8ab Mon Sep 17 00:00:00 2001 From: Josh Triplett Date: Tue, 1 Nov 2022 14:46:05 +0100 Subject: [PATCH 2/2] Change "how will this" to just "will this" "how will this" comes across as though *every* RFC is about making code easier to maintain. Some RFCs may just be maintenance-neutral. --- 0000-template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/0000-template.md b/0000-template.md index 85e8ad702..be46af0d7 100644 --- a/0000-template.md +++ b/0000-template.md @@ -23,7 +23,7 @@ Explain the proposal as if it was already included in the language and you were - 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. - If applicable, provide sample error messages, deprecation warnings, or migration guidance. - If applicable, describe the differences between teaching this to existing Rust programmers and new Rust programmers. -- 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? +- Discuss how this impacts the ability to read, understand, and maintain Rust code. Code is read and modified far more often than written; will the proposed feature make code easier to maintain? 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.