Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?

Structure

When creating an RFC please follow the following structure:

Date: dd/mm/yyyy

  • RFC PR: (< link >)
  • Jira Ticket: (< link >)
  • Code PR: (< link >)

Summary

Describe in a few words the problem

Problem

Describe the problem/task in detail with the what causes it or its need.

Proposal

Describe the solution as concise as possible and dont forget to add pseudo code to better illustrate it. If you would like to add pictures, please add the pictures in the /rfc/images folder of this repository and link to them.

Also dont forget to add drawbacks to this solution

Alternatives

Add the alternatives that came to your mind at the time.

Other

Add all the unresolved questions or comments that you think are relevant.

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