Skip to content

Instantly share code, notes, and snippets.

@wardenlym
Forked from eminetto/rfc.md
Created March 7, 2022 06:09
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 wardenlym/a0577f78b1fa761fb9a677cee51f651b to your computer and use it in GitHub Desktop.
Save wardenlym/a0577f78b1fa761fb9a677cee51f651b to your computer and use it in GitHub Desktop.
Template of RFCs

Title

Problem description

We must explain the problem clearly and identify additional details that the team needs to know. We must here describe the context, what we did so far, and the current state.

The description also serves as a trail that we can go back to in the future to understand the reasoning we had at the time and see what restrictions and requirements have changed.

Possible approaches

In this section, we should write two or three possible approaches that we have considered. We must evaluate the benefits and disadvantages of each solution. We also explain what is not feasible and what is the fastest to implement.

Option 1

Benefits

Disadvantages

Option 2

Benefits

Disadvantages

Conclusion

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

Unsolved issues

If any part of the problem will remain open - whether it is technical or not - we must put it here.

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