Design Title
May 14, 2021 ยท View on GitHub
- Author:
- Issue:
- Date:
- Reviewer:
- Review status: pending / reviewing / approved / declined
Objective
One or two phrases describing what are you trying to achieve with this design.
Background
Describing the context of this design, such as what are the issues, similar relevant efforts, etc. It should be understandable by future contributors.
Design overview
A short paragraph describing the key concepts. Such as the main assumption, the key constraints, high-level design concepts, success criteria, etc.
Detailed design
Outlining your detailed solution here. Please explicitly call out your new API or database changes below if any, also describe any backward compatibility consideration. Also watch out for any potential concerns over performance, concurrency, security and privacy.