From 6611901db0201d196648703f27c0af9df50a3fec Mon Sep 17 00:00:00 2001 From: Andy Kwok Date: Wed, 20 Nov 2024 12:10:04 -0800 Subject: [PATCH 1/2] RFC template draft Signed-off-by: Andy Kwok --- .github/ISSUE_TEMPLATE/request_of_comments.md | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/request_of_comments.md diff --git a/.github/ISSUE_TEMPLATE/request_of_comments.md b/.github/ISSUE_TEMPLATE/request_of_comments.md new file mode 100644 index 0000000000..36509b7c21 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/request_of_comments.md @@ -0,0 +1,28 @@ +--- +name: 📄 Request of comments +about: Create a request of comments to initiate an discussion on feature implementation / design. +title: '[RFC]' +labels: 'rfc, untriaged' +assignees: '' +--- + +**Problem Statement** +Describes the issue or challenge that needs to be addressed. + +**Current State** +Explains the existing setup or context and its shortcomings. + +**Proposal** +Summarizes the suggested solution or improvement. + +**Approach** +Details the steps or strategy to implement the proposal. + +**API Design** +Outlines the interface specifications for any involved APIs. + +**Known Limitation** +Lists constraints or challenges anticipated in the solution. + +**Do you have any additional context?** +Add any other context about the problem. From 6fdf5f263211bc6806ff8d3b5e235fdbf2b5978e Mon Sep 17 00:00:00 2001 From: Andy Kwok Date: Fri, 3 Jan 2025 13:29:30 -0800 Subject: [PATCH 2/2] Update template Signed-off-by: Andy Kwok --- .github/ISSUE_TEMPLATE/request_of_comments.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/request_of_comments.md b/.github/ISSUE_TEMPLATE/request_of_comments.md index 36509b7c21..a7798eafd2 100644 --- a/.github/ISSUE_TEMPLATE/request_of_comments.md +++ b/.github/ISSUE_TEMPLATE/request_of_comments.md @@ -12,17 +12,25 @@ Describes the issue or challenge that needs to be addressed. **Current State** Explains the existing setup or context and its shortcomings. +**Long-Term Goals** +* Describe the ideal outcome or future state you aim to achieve. +* What are the primary objectives of this solution should fulfill in the long run? +* How will this solution ensure sustainability or scalability over time? +* Consider whether the solution addresses the root problem and aligns with the overall goals. + +-[ ] Does the solution solve the problem? + **Proposal** Summarizes the suggested solution or improvement. **Approach** Details the steps or strategy to implement the proposal. -**API Design** -Outlines the interface specifications for any involved APIs. - -**Known Limitation** -Lists constraints or challenges anticipated in the solution. +**Alternative** +Alternative that can serve as workarounds to partially or temporarily solve the problem. **Do you have any additional context?** Add any other context about the problem. + +**Implementation Discussion** +Outlines point the discussion regarding the proposed implementation.