rust
/
rfcs
mirror of https://github.com/rust-lang/rfcs
1
0
Fork 0
Code Issues Releases Wiki Activity
rfcs/0000-template.md

54 lines
2.1 KiB
Markdown
Raw Normal View History

Add back the template
2016-04-21 16:22:22 +00:00
- Feature Name: (fill me in with a unique ident, my_awesome_feature)
- Start Date: (fill me in with today's date, YYYY-MM-DD)
- RFC PR: (leave this empty)
- Rust Issue: (leave this empty)
# Summary
[summary]: #summary
One para explanation of the feature.
# Motivation
[motivation]: #motivation
Why are we doing this? What use cases does it support? What is the expected outcome?
Switch to "Guide-level" and "Reference-level" explanations As proposed by aturon <3 These sections replace the "Detailed design" and "How do we teach this?" sections, and switch their order. Instead of describing how we would teach a change as a result of a proposal, the "Guide-level explanation" section will actually attempt to teach the reader the feature, in a lightweight way. The guide-level explanation appears first in order to help RFC writers keep Rust users in the front of their minds, and in order to help RFC readers understand how an RFC will affect them sooner in the RFC. This will hopefully make the RFC process more accessible to people who are Rust users but not compiler or language design experts.
2017-07-12 23:42:36 +00:00
# Guide-level explanation
[guide-level-explanation]: #guide-level-explanation
Add back the template
2016-04-21 16:22:22 +00:00
Switch to "Guide-level" and "Reference-level" explanations As proposed by aturon <3 These sections replace the "Detailed design" and "How do we teach this?" sections, and switch their order. Instead of describing how we would teach a change as a result of a proposal, the "Guide-level explanation" section will actually attempt to teach the reader the feature, in a lightweight way. The guide-level explanation appears first in order to help RFC writers keep Rust users in the front of their minds, and in order to help RFC readers understand how an RFC will affect them sooner in the RFC. This will hopefully make the RFC process more accessible to people who are Rust users but not compiler or language design experts.
2017-07-12 23:42:36 +00:00
Explain the proposal as if it was already included in the language and you were teaching it to another Rust programmer. That generally means:
Add back the template
2016-04-21 16:22:22 +00:00
Switch to "Guide-level" and "Reference-level" explanations As proposed by aturon <3 These sections replace the "Detailed design" and "How do we teach this?" sections, and switch their order. Instead of describing how we would teach a change as a result of a proposal, the "Guide-level explanation" section will actually attempt to teach the reader the feature, in a lightweight way. The guide-level explanation appears first in order to help RFC writers keep Rust users in the front of their minds, and in order to help RFC readers understand how an RFC will affect them sooner in the RFC. This will hopefully make the RFC process more accessible to people who are Rust users but not compiler or language design experts.
2017-07-12 23:42:36 +00:00
- Introducing new named concepts.
- Explaining the feature largely in terms of examples.
- 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.
Add a line about existing vs new Rust programmers
2017-07-12 23:52:34 +00:00
- If applicable, describe the differences between teaching this to existing Rust programmers and new Rust programmers.
Add 'How We Teach This' to template, per RFC 1636.
2016-12-07 02:47:14 +00:00
Switch to "Guide-level" and "Reference-level" explanations As proposed by aturon <3 These sections replace the "Detailed design" and "How do we teach this?" sections, and switch their order. Instead of describing how we would teach a change as a result of a proposal, the "Guide-level explanation" section will actually attempt to teach the reader the feature, in a lightweight way. The guide-level explanation appears first in order to help RFC writers keep Rust users in the front of their minds, and in order to help RFC readers understand how an RFC will affect them sooner in the RFC. This will hopefully make the RFC process more accessible to people who are Rust users but not compiler or language design experts.
2017-07-12 23:42:36 +00:00
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.
Add 'How We Teach This' to template, per RFC 1636.
2016-12-07 02:47:14 +00:00
Switch to "Guide-level" and "Reference-level" explanations As proposed by aturon <3 These sections replace the "Detailed design" and "How do we teach this?" sections, and switch their order. Instead of describing how we would teach a change as a result of a proposal, the "Guide-level explanation" section will actually attempt to teach the reader the feature, in a lightweight way. The guide-level explanation appears first in order to help RFC writers keep Rust users in the front of their minds, and in order to help RFC readers understand how an RFC will affect them sooner in the RFC. This will hopefully make the RFC process more accessible to people who are Rust users but not compiler or language design experts.
2017-07-12 23:42:36 +00:00
# Reference-level explanation
[reference-level-explanation]: #reference-level-explanation
Add 'How We Teach This' to template, per RFC 1636.
2016-12-07 02:47:14 +00:00
Switch to "Guide-level" and "Reference-level" explanations As proposed by aturon <3 These sections replace the "Detailed design" and "How do we teach this?" sections, and switch their order. Instead of describing how we would teach a change as a result of a proposal, the "Guide-level explanation" section will actually attempt to teach the reader the feature, in a lightweight way. The guide-level explanation appears first in order to help RFC writers keep Rust users in the front of their minds, and in order to help RFC readers understand how an RFC will affect them sooner in the RFC. This will hopefully make the RFC process more accessible to people who are Rust users but not compiler or language design experts.
2017-07-12 23:42:36 +00:00
This is the technical portion of the RFC. Explain the design in sufficient detail that:
Add 'How We Teach This' to template, per RFC 1636.
2016-12-07 02:47:14 +00:00
Switch to "Guide-level" and "Reference-level" explanations As proposed by aturon <3 These sections replace the "Detailed design" and "How do we teach this?" sections, and switch their order. Instead of describing how we would teach a change as a result of a proposal, the "Guide-level explanation" section will actually attempt to teach the reader the feature, in a lightweight way. The guide-level explanation appears first in order to help RFC writers keep Rust users in the front of their minds, and in order to help RFC readers understand how an RFC will affect them sooner in the RFC. This will hopefully make the RFC process more accessible to people who are Rust users but not compiler or language design experts.
2017-07-12 23:42:36 +00:00
- Its interaction with other features is clear.
- It is reasonably clear how the feature would be implemented.
- Corner cases are dissected by example.
Add some more prompts to the "How do we teach this?" section
2017-06-26 23:21:05 +00:00
Switch to "Guide-level" and "Reference-level" explanations As proposed by aturon <3 These sections replace the "Detailed design" and "How do we teach this?" sections, and switch their order. Instead of describing how we would teach a change as a result of a proposal, the "Guide-level explanation" section will actually attempt to teach the reader the feature, in a lightweight way. The guide-level explanation appears first in order to help RFC writers keep Rust users in the front of their minds, and in order to help RFC readers understand how an RFC will affect them sooner in the RFC. This will hopefully make the RFC process more accessible to people who are Rust users but not compiler or language design experts.
2017-07-12 23:42:36 +00:00
The section should return to the examples given in the previous section, and explain more fully how the detailed proposal makes those examples work.
Add some more prompts to the "How do we teach this?" section
2017-06-26 23:21:05 +00:00
Add back the template
2016-04-21 16:22:22 +00:00
# Drawbacks
[drawbacks]: #drawbacks
Why should we *not* do this?
# Alternatives
[alternatives]: #alternatives
What other designs have been considered? What is the impact of not doing this?
# Unresolved questions
[unresolved]: #unresolved-questions
What parts of the design are still TBD?