Skip to content
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 95 additions & 0 deletions docs/rfcs/0000-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
- Feature Name: (fill me in with a unique ident, `my_awesome_feature`)
Comment thread
aevyrie marked this conversation as resolved.
Outdated
- Start Date: (fill me in with today's date, YYYY-MM-DD)
Comment thread
aevyrie marked this conversation as resolved.
Outdated
- RFC PR: [rust-lang/rfcs#0000](https://github.com/rust-lang/rfcs/pull/0000)
Comment thread
aevyrie marked this conversation as resolved.
Outdated
- Rust Issue: [rust-lang/rust#0000](https://github.com/rust-lang/rust/issues/0000)
Comment thread
aevyrie marked this conversation as resolved.
Outdated
Comment thread
aevyrie marked this conversation as resolved.
Outdated

# Summary
Comment thread
aevyrie marked this conversation as resolved.
Outdated
[summary]: #summary
Comment thread
aevyrie marked this conversation as resolved.
Outdated

One paragraph explanation of the feature.

# Motivation
Comment thread
aevyrie marked this conversation as resolved.
Outdated
[motivation]: #motivation
Comment thread
aevyrie marked this conversation as resolved.
Outdated

Why are we doing this? What use cases does it support? What is the expected outcome?
Comment thread
aevyrie marked this conversation as resolved.
Outdated

# Guide-level explanation
Comment thread
aevyrie marked this conversation as resolved.
Outdated
[guide-level-explanation]: #guide-level-explanation
Comment thread
aevyrie marked this conversation as resolved.
Outdated

Explain the proposal as if it was already included in the language and you were teaching it to another Rust programmer. That generally means:
Comment thread
aevyrie marked this conversation as resolved.
Outdated

- Introducing new named concepts.
- Explaining the feature largely in terms of examples.
Comment thread
aevyrie marked this conversation as resolved.
Outdated
- 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.
Comment thread
aevyrie marked this conversation as resolved.
Outdated
Comment thread
aevyrie marked this conversation as resolved.
Outdated
- 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.
Comment thread
aevyrie marked this conversation as resolved.
Outdated

Comment thread
aevyrie marked this conversation as resolved.
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.
Comment thread
aevyrie marked this conversation as resolved.
Outdated

# Reference-level explanation
Comment thread
aevyrie marked this conversation as resolved.
Outdated
[reference-level-explanation]: #reference-level-explanation
Comment thread
aevyrie marked this conversation as resolved.
Outdated

This is the technical portion of the RFC. Explain the design in sufficient detail that:

- Its interaction with other features is clear.
- It is reasonably clear how the feature would be implemented.
- Corner cases are dissected by example.

The section should return to the examples given in the previous section, and explain more fully how the detailed proposal makes those examples work.

# Drawbacks
Comment thread
aevyrie marked this conversation as resolved.
Outdated
[drawbacks]: #drawbacks
Comment thread
aevyrie marked this conversation as resolved.
Outdated

Why should we *not* do this?

# Rationale and alternatives
Comment thread
aevyrie marked this conversation as resolved.
Outdated
Comment thread
aevyrie marked this conversation as resolved.
Outdated
[rationale-and-alternatives]: #rationale-and-alternatives
Comment thread
aevyrie marked this conversation as resolved.
Outdated

- 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?
Comment thread
aevyrie marked this conversation as resolved.

# Prior art
Comment thread
aevyrie marked this conversation as resolved.
Outdated
[prior-art]: #prior-art
Comment thread
aevyrie marked this conversation as resolved.
Outdated

Discuss prior art, both the good and the bad, in relation to this proposal.
A few examples of what this can include are:
Comment thread
aevyrie marked this conversation as resolved.
Outdated

- For language, library, cargo, tools, and compiler proposals: Does this feature exist in other programming languages and what experience have their community had?
Comment thread
aevyrie marked this conversation as resolved.
Outdated
- For community proposals: Is this done by some other community and what were their experiences with it?
Comment thread
aevyrie marked this conversation as resolved.
Outdated
- For other teams: What lessons can we learn from what other communities have done here?
Comment thread
aevyrie marked this conversation as resolved.
Outdated
- Papers: Are there any published papers or great posts that discuss this? If you have some relevant papers to refer to, this can serve as a more detailed theoretical background.
Comment thread
aevyrie marked this conversation as resolved.
Outdated

This section is intended to encourage you as an author to think about the lessons from other languages, provide readers of your RFC with a fuller picture.
Comment thread
aevyrie marked this conversation as resolved.
Outdated
If there is no prior art, that is fine - your ideas are interesting to us whether they are brand new or if it is an adaptation from other languages.
Comment thread
aevyrie marked this conversation as resolved.
Outdated

Note that while precedent set by other languages is some motivation, it does not on its own motivate an RFC.
Comment thread
aevyrie marked this conversation as resolved.
Outdated
Please also take into consideration that rust sometimes intentionally diverges from common language features.
Comment thread
aevyrie marked this conversation as resolved.
Outdated

# Unresolved questions
Comment thread
aevyrie marked this conversation as resolved.
Outdated
[unresolved-questions]: #unresolved-questions
Comment thread
aevyrie marked this conversation as resolved.
Outdated

- What parts of the design do you expect to resolve through the RFC process before this gets merged?
- What parts of the design do you expect to resolve through the implementation of this feature before stabilization?
Comment thread
aevyrie marked this conversation as resolved.
Outdated
- What related issues do you consider out of scope for this RFC that could be addressed in the future independently of the solution that comes out of this RFC?

# Future possibilities
Comment thread
aevyrie marked this conversation as resolved.
Outdated
[future-possibilities]: #future-possibilities
Comment thread
aevyrie marked this conversation as resolved.
Outdated

Think about what the natural extension and evolution of your proposal would
be and how it would affect the language and project as a whole in a holistic
Comment thread
aevyrie marked this conversation as resolved.
Outdated
way. Try to use this section as a tool to more fully consider all possible
Comment thread
aevyrie marked this conversation as resolved.
Outdated
interactions with the project and language in your proposal.
Also consider how this all fits into the roadmap for the project
and of the relevant sub-team.
Comment thread
aevyrie marked this conversation as resolved.
Outdated

This is also a good place to "dump ideas", if they are out of scope for the
RFC you are writing but otherwise related.

Comment thread
aevyrie marked this conversation as resolved.
If you have tried and cannot think of any future possibilities,
Comment thread
aevyrie marked this conversation as resolved.
Outdated
you may simply state that you cannot think of anything.
Comment thread
aevyrie marked this conversation as resolved.
Outdated

Note that having something written down in the future-possibilities section
is not a reason to accept the current or a future RFC; such notes should be
in the section on motivation or rationale in this or subsequent RFCs.
The section merely provides additional information.
Comment thread
aevyrie marked this conversation as resolved.
Outdated