From b8577294bf50ac949c7da3ecff91b4fd7884739d Mon Sep 17 00:00:00 2001 From: Eyal Toledano Date: Thu, 10 Apr 2025 02:26:42 -0400 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 33 ++++++++++++++ .../enhancements---feature-requests.md | 44 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feedback.md | 26 +++++++++++ 3 files changed, 103 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/enhancements---feature-requests.md create mode 100644 .github/ISSUE_TEMPLATE/feedback.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..3e43a954 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,33 @@ +--- +name: Bug report +about: Create a report to help us improve +title: 'bug: ' +labels: bug +assignees: '' + +--- + +### Description +Detailed description of the problem, including steps to reproduce the issue. + +### Steps to Reproduce +1. Step-by-step instructions to reproduce the issue +2. Include command examples or UI interactions + +### Expected Behavior +Describe clearly what the expected outcome or behavior should be. + +### Actual Behavior +Describe clearly what the actual outcome or behavior is. + +### Screenshots or Logs +Provide screenshots, logs, or error messages if applicable. + +### Environment +- Task Master version: +- Node.js version: +- Operating system: +- IDE (if applicable): + +### Additional Context +Any additional information or context that might help diagnose the issue. diff --git a/.github/ISSUE_TEMPLATE/enhancements---feature-requests.md b/.github/ISSUE_TEMPLATE/enhancements---feature-requests.md new file mode 100644 index 00000000..1dda17d2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancements---feature-requests.md @@ -0,0 +1,44 @@ +--- +name: Enhancements & feature requests +about: Suggest an idea for this project +title: 'feat: ' +labels: enhancement +assignees: '' + +--- + +> "Direct quote or clear summary of user request or need or user story." + +### Motivation +Detailed explanation of why this feature is important. Describe the problem it solves or the benefit it provides. + +### Proposed Solution +Clearly describe the proposed feature, including: +- High-level overview of the feature +- Relevant technologies or integrations +- How it fits into the existing workflow or architecture + +### High-Level Workflow +1. Step-by-step description of how the feature will be implemented +2. Include necessary intermediate milestones + +### Key Elements +- Bullet-point list of technical or UX/UI enhancements +- Mention specific integrations or APIs +- Highlight changes needed in existing data models or commands + +### Example Workflow +Provide a clear, concrete example demonstrating the feature: + +```shell +$ task-master [action] +→ Expected response/output +``` + +### Implementation Considerations +- Dependencies on external components or APIs +- Backward compatibility requirements +- Potential performance impacts or resource usage + +### Out of Scope (Future Considerations) +Clearly list any features or improvements not included but relevant for future iterations. diff --git a/.github/ISSUE_TEMPLATE/feedback.md b/.github/ISSUE_TEMPLATE/feedback.md new file mode 100644 index 00000000..45097b5b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feedback.md @@ -0,0 +1,26 @@ +--- +name: Feedback +about: Give us specific feedback on the product/approach/tech +title: 'feedback: ' +labels: feedback +assignees: '' + +--- + +### Feedback Summary +Provide a clear summary or direct quote from user feedback. + +### User Context +Explain the user's context or scenario in which this feedback was provided. + +### User Impact +Describe how this feedback affects the user experience or workflow. + +### Suggestions +Provide any initial thoughts, potential solutions, or improvements based on the feedback. + +### Relevant Screenshots or Examples +Attach screenshots, logs, or examples that illustrate the feedback. + +### Additional Notes +Any additional context or related information.