Skip to content

Instantly share code, notes, and snippets.

@fmendes6

fmendes6/rfc_template.md

Created September 20, 2018 18:55
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 fmendes6/709425fc251d418edf4281fcb8b60f44 to your computer and use it in GitHub Desktop.
Save fmendes6/709425fc251d418edf4281fcb8b60f44 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
rfc_template.md

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