-
-
Notifications
You must be signed in to change notification settings - Fork 4k
RFC: Create an RFC Process #1662
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
f6570ac
Copy rust's rfc template
aevyrie 946953e
Apply suggestions from code review
aevyrie c6a761c
Apply suggestions from code review
aevyrie 941af8a
Update 0000-template.md
aevyrie 567f599
Apply suggestions from code review
aevyrie 094fc60
Apply suggestions from code review
aevyrie eaccd19
Update CONTRIBUTING.md
aevyrie 7b8cc72
Apply suggestions from code review
aevyrie de92b3c
Apply suggestions from code review
aevyrie File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
- Feature Name: (fill me in with a unique ident, `my_awesome_feature`) | ||
- Start Date: (fill me in with today's date, YYYY-MM-DD) | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
# Summary | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
[summary]: #summary | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
One paragraph explanation of the feature. | ||
|
||
# Motivation | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
[motivation]: #motivation | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Why are we doing this? What use cases does it support? | ||
|
||
# Guide-level explanation | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
[guide-level-explanation]: #guide-level-explanation | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Explain the proposal as if it was already included in the language and you were teaching it to another Bevy user. That generally means: | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- Introducing new named concepts. | ||
- Explaining the feature, largely in terms of examples grounded in simple and common game constructs. | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- Explaining how Bevy users should *think* about the feature, and how it should impact the way they use Bevy. It should explain the impact as concretely as possible. | ||
- If applicable, provide sample error messages, deprecation warnings, or migration guidance. | ||
|
||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
# Reference-level explanation | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
[reference-level-explanation]: #reference-level-explanation | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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 | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
[drawbacks]: #drawbacks | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Why should we *not* do this? | ||
|
||
# Rationale and alternatives | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
[rationale-and-alternatives]: #rationale-and-alternatives | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- 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? | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
# Prior art | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
[prior-art]: #prior-art | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Discuss prior art, both the good and the bad, in relation to this proposal. | ||
A few examples of what this can include are: | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- For language, library, cargo, tools, and compiler proposals: Does this feature exist in other programming languages and what experience have their community had? | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- For community proposals: Is this done by some other community and what were their experiences with it? | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- For other teams: What lessons can we learn from what other communities have done here? | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- 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. | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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. | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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. | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Note that while precedent set by other languages is some motivation, it does not on its own motivate an RFC. | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Please also take into consideration that rust sometimes intentionally diverges from common language features. | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
# Unresolved questions | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
[unresolved-questions]: #unresolved-questions | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- 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 the feature PR is merged? | ||
- 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 | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
[future-possibilities]: #future-possibilities | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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 | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
way. Try to use this section as a tool to more fully consider all possible | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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. | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
This is also a good place to "dump ideas", if they are out of scope for the | ||
RFC you are writing but otherwise related. | ||
|
||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
If you have tried and cannot think of any future possibilities, | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
you may simply state that you cannot think of anything. | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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. | ||
aevyrie marked this conversation as resolved.
Show resolved
Hide resolved
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.