Skip to content

Latest commit

 

History

History
112 lines (80 loc) · 3.73 KB

rfc_template.md

File metadata and controls

112 lines (80 loc) · 3.73 KB

Title (see source to read the comments )

Authors:

  • @githubusername

1 TL;DR

2 Motivation

3 Proposed Implementation

4 Metrics & Dashboards

5 Drawbacks

6 Alternatives

7 Potential Impact and Dependencies

8 Unresolved questions

9 Conclusion

10 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.
  • Tag RFC title with [SWARCH] if you'd like to schedule a SWARCH review to discuss the RFC.
  • 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 success of the implementation of your proposal depends on how this decision relates to our company objectives and priorities.