Skip to content

Instantly share code, notes, and snippets.

@nhocki

nhocki/RFC template.md

Created April 1, 2022 17:10
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 nhocki/0dcdeb855a16f1adb366f11652aa1e15 to your computer and use it in GitHub Desktop.
Save nhocki/0dcdeb855a16f1adb366f11652aa1e15 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
RFC template.md

Title

Authors:

  • @githubusername

1 TL;DR

2 Motivation

3 Proposed Implementation

4 Drawbacks

5 Alternatives

6 Potential Impact and Dependencies

7 Unresolved questions

8 Conclusion

9 RFC Process, remove this section when done

  • Copy template
  • Draft RFC (think of it as a wireframe)
  • Share as WIP with folks you trust, to gut-check
  • Send pull request when comfortable
  • Label accordingly
  • Assign reviewers (ask your manager if in doubt)
  • Merge yourself with 2 approved reviews

Recommendations

  • Tag RFC title with [WIP] if you're still ironing out details.
  • Tag RFC title with [newbie] if you're trying out something experimental, or you're not completely convinced of what you're proposing.
  • If there are areas that you're not convinced on, tag people who you consider may know about this and ask for their input.
  • If you have doubts, ask your manager for help moving something forward.
  • As the author/s, this is your decision and are empowered to choose to move forward despite dissenting comment. We're not looking for consensus driven decision making.
  • The sucess of the implementation of your proposal depends on how this decision relates to our company objectives and priorities.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment