Skip to content

Instantly share code, notes, and snippets.

@helderberto

helderberto/rfc.md

Last active May 17, 2021 10:30
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save helderberto/f555fe1d168a6da2f5fe81f1df3daca8 to your computer and use it in GitHub Desktop.
Save helderberto/f555fe1d168a6da2f5fe81f1df3daca8 to your computer and use it in GitHub Desktop.
Download ZIP
RFC Template
Raw
rfc.md
  • RFC: Title of RFC
  • Created: YYYY-MM-DD
  • Last Update: YYYY-MM-DD

Summary

If someone only reads this far, what do you want them to know?

Goals

What problems are you trying to solve?

Motivation

Why is this change being proposed?

Design

What exactly are you doing? Include architecture and process diagrams.

Dependencies

What existing internal and external systems does this one depend on? How will it use them?

Possible Approaches

Describe two or more possible approaches to be considered, it needs to be discussed the advantages and disadvantages of every option. Explain what is faster and quicker to implement.

Option 01

Advantages

Disadvantages

Option 02

Advantages

Disadvantages

Conclusion

In the concluding section, we explain which of the solutions we think is the best option. When necessary, steps for the different iterations of the solution can also be described.

Questions and Discussion Topics

Seed this with open questions you require feedback on from the RFC process.

References

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment