Skip to content

Latest commit

 

History

History
110 lines (83 loc) · 5.07 KB

0000-template.md

File metadata and controls

110 lines (83 loc) · 5.07 KB
Raw

Table of Contents

Basic Info

  • 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 until a PR is opened)
  • Tracking Issue: (leave this empty)
  • Forum Thread: (if there is one)

After filling out these fields, please proceed to fill out the remaining sections of this document.

Summary

One paragraph explanation of the feature.

Amethyst Community Forum Discussion

You can access our forums at https://community.amethyst-engine.org

Information about pre-RFC discussion on our community forum There is a category on our forums for what can be considered pre-RFC discussion. It is a good place to get some quick feedback from the community without having to go through the entire process.

This is not required, but if one exists and contains useful information, you may place a link to it here.

Motivation

Why are we doing this? What use cases does it support? What is the expected outcome?

Guide-Level Explanation

Non-technical overview and reasoning for it. Explain the proposal as if it was already included in the language and you were teaching it to another Amethyst programmer. That generally means:
  • Introducing new named concepts.
  • Explaining the feature largely in terms of examples.
  • Explaining how Amethyst developers should think about the feature, and how it should impact the way they use Amethyst. 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 Amethyst programmers and new Amethyst programmers.

For implementation-oriented RFCs (e.g. for changes to the engine), this section should focus on how engine 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.

Reference-Level Explanation

The technical details and design of the RFC. 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

Why should we not do this?

Rationale and Alternatives

  • 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?

Prior Art

Discuss previous attempts, both good and bad, and how they relate to this proposal. A few examples of what this can include are:
  • For engine, network, web, and rendering proposals: Does this feature exist in other engines and what experience has their community had?
  • For community proposals: Is this done by some other community and what were their experiences with it?
  • For other teams: What lessons can we learn from what other communities have done here?
  • 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.

This section is intended to encourage you as an author to think about the lessons from other engines, provide readers of your RFC with a fuller picture. 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 engines.

Unresolved Questions

Additional questions to consider
  • 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?
  • 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?

Copyright 2018 Amethyst Developers