Skip to content

Latest commit

 

History

History
60 lines (38 loc) · 2.16 KB

rfc-0000-template.md

File metadata and controls

60 lines (38 loc) · 2.16 KB

Summary

One paragraph overview of the feature

Motivation

Why is this RFC being made, what does it achieve or solve, what is the expected outcome

Guide-level explanation

Explain the proposal as if it's already in Revolt and you were teaching it to new users.

  • Introduce new concepts
  • Explain the feature with examples
  • What this fixes or adds and what users should think of the feature
  • Discuss how this impacts using Revolt, how it makes it harder or easier to use

For internal oriented RFCs such as internal code changes, this should largely talk about how contributors should think about the change and give examples on the impacts.

Reference-level explanation

This is the technical section of the RFC, it should go over in detail:

  • Its interaction with other features
  • How this will be implemented
  • Corner or edge cases

This section should reference the examples in the previous section and disect them in more detail.

Drawbacks

Why should this not be added.

Rationale and alternatives

  • Why is this design the best
  • Are there alternative ways to solve this
  • Could this be done with existing features or existing solutions

Prior art

This should include both good and bad outlooks on the proposal. This could include how other platforms, software and hardware solve similar issues if relevent or how any existing proposals have tried to solve the same problem.

Unresolved questions

  • Are there any parts which are not yet designed or you believe need further discussion?
  • Do you expect any part of this proposal to change?
  • Are there any related issues which you believe are out of the scope of this RFC that could be addressed in a seperate RFC?

Security concerns

How does this RFC impact security - This section might not always be applicable and if you believe it is not, please write your reasoning in this section.

Future ideas

Are there any features or changes that this proposal could enable? How does this proposal impact the future of Revolt?