Closed ngawangtrinley closed 2 years ago
Please add ref in specified format into RFC title, e.g [RFC9999] if corresponding RFW is [RFW9999].
RFC
[RFC9999]
[RFW9999]
Please add into this RFC and related PR's titles [RFC_id] e.g [RFC_9999].
PR's
[RFC_id]
[RFC_9999]
ALL BELOW FIELDS ARE REQUIRED
Explain any new concepts introduced in this request.
Explain in a Single paragraph what this request is about.
This section provides a detailed technical overview of the work. The design is explained with enough depth and detail to make it clear how:
This section includes practical examples and explain how this proposal makes those examples work.
This section becomes the engineering specification and work plan, so it must be sufficiently detailed to faciliate for that.
Confirm that alternative approaches have been evaluated and explain those alternatives briefly.
Describe any particular caveats and drawbacks that may arise from fulfilling this particular request?
Describe useful parallels and learnings from other requests, or work in previous projects.
How do you see the particular system or part of the system affected by this request be altered or extended in the future.
Describe the new infrastructure or changes in current infrastructure required to fulfill this request.
Describe the kind of testing procedures that are needed as part of fulfilling this request.
Describe the level of documentation fulfilling this request involves. Consider both end-user documentation and developer documentation.
History of changes to this RFC. Following semantic versioning pattern and v0.1.2 for style.
Links to audio recordings of related discussion.
Keep original naming and structure, and keep as first section in Work phases section
A list of checkboxes, one per PR. Each PR should have a descriptive name that clearly illustrates what the work phase is about.
Table of Contents
Housekeeping
Please add ref in specified format into
RFC
title, e.g[RFC9999]
if corresponding RFW is[RFW9999]
.Please add into this
RFC
and relatedPR's
titles[RFC_id]
e.g[RFC_9999]
.ALL BELOW FIELDS ARE REQUIRED
Named Concepts
Explain any new concepts introduced in this request.
Summary
Explain in a Single paragraph what this request is about.
Reference-Level Explanation
This section provides a detailed technical overview of the work. The design is explained with enough depth and detail to make it clear how:
This section includes practical examples and explain how this proposal makes those examples work.
This section becomes the engineering specification and work plan, so it must be sufficiently detailed to faciliate for that.
Alternatives
Confirm that alternative approaches have been evaluated and explain those alternatives briefly.
Rationale
Drawbacks
Describe any particular caveats and drawbacks that may arise from fulfilling this particular request?
Useful References
Describe useful parallels and learnings from other requests, or work in previous projects.
Unresolved Questions
Parts of the System Affected
Future possibilities
How do you see the particular system or part of the system affected by this request be altered or extended in the future.
Infrastructure
Describe the new infrastructure or changes in current infrastructure required to fulfill this request.
Testing
Describe the kind of testing procedures that are needed as part of fulfilling this request.
Documentation
Describe the level of documentation fulfilling this request involves. Consider both end-user documentation and developer documentation.
Version History
History of changes to this RFC. Following semantic versioning pattern and v0.1.2 for style.
Recordings
Links to audio recordings of related discussion.
Work Phases
Non-Coding
Keep original naming and structure, and keep as first section in Work phases section
Implementation
A list of checkboxes, one per PR. Each PR should have a descriptive name that clearly illustrates what the work phase is about.