Skip to content

Instantly share code, notes, and snippets.

@glprog
Forked from eminetto/rfc.md
Created May 24, 2021 11:40
Show Gist options
  • Save glprog/e28a03b7e8c513b481df2f73fdd64fbd to your computer and use it in GitHub Desktop.
Save glprog/e28a03b7e8c513b481df2f73fdd64fbd to your computer and use it in GitHub Desktop.

Revisions

  1. Elton Minetto created this gist May 22, 2021.
    32 changes: 32 additions & 0 deletions rfc.md
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,32 @@
    # 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.