[RFC]

[ngawangtrinley]

Table of Contents

• Housekeeping
• Named Concepts
• Summary
• Reference-Level Explanation
• Alternatives
  • Rationale
• Drawbacks
• Useful References
• Unresolved questions
• Parts of the system affected
• Future possibilities
• Infrastructure
• Testing
• Documentation
• Version History
• Recordings
• Work Phases

Housekeeping

Please add ref in specified format into RFC title, e.g [RFC9999] if corresponding RFW is [RFW9999].

Please add into this RFC and related PR'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:

• The proposed changes interact with other systems (or other parts of the system that is changed)
• The actual implementation will take place
• Known challenges can be readily overcome

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

• Why the currently proposed design was selected over alternatives?
• What would be the impact of going with one of the alternative approaches?
• Is the evaluation tentative, or is it recommended to use more time to evaluate different approaches?

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.

• What similar work have we already successfully completed?
• Is this something that have already been built by others?
• What other related learnings we have?
• Are there useful academic literature or other articles related with this topic? (provide links)
• Have we built a relevant prototype previously?
• Do we have a rough mock for the UI/UX?
• Do we have a schematic for the system?

Unresolved Questions

• What is there that is unresolved (and will be resolved as part of fulfilling this request)?
• Are there other requests with same or similar problems to solve?

Parts of the System Affected

• Which parts of the current system are affected by this request?
• What other open requests are closely related with this request?
• Does this request depend on fulfillment of any other request?
• Does any other request depend on the fulfillment of this request?*

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

• [ ] Planning
• [ ] Documentation
• [ ] Testing

Implementation

A list of checkboxes, one per PR. Each PR should have a descriptive name that clearly illustrates what the work phase is about.