From 592f4d3e00756eba113ea5ea0343669fc8b0b84d Mon Sep 17 00:00:00 2001 From: OpenWaygate <27287694+OpenWaygate@users.noreply.github.com> Date: Tue, 21 Oct 2025 22:45:05 +0800 Subject: [PATCH] :memo: Improve issue template --- .github/ISSUE_TEMPLATE/bug_report.md | 51 +++++++++------ .github/ISSUE_TEMPLATE/feature_request.md | 76 ++++++++++++++++++++--- 2 files changed, 97 insertions(+), 30 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 5d3171a..3adf9fc 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,32 +1,43 @@ --- name: Bug report -about: Create a report to help us improve -title: "[BUG]" +about: Create a report to help us improve yutu +title: "[BUG] " labels: bug assignees: '' --- -**Describe the bug** -A clear and concise description of what the bug is. +## 🐛 Bug Description -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error + -**Expected behavior** -A clear and concise description of what you expected to happen. +## 📋 Environment Information -**Screenshots** -If applicable, add screenshots to help explain your problem. +### System Details -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] +- **OS**: +- **Yutu Version**: +- **Installation Method**: +- **Go Version**: -**Additional context** -Add any other context about the problem here. +## 🔄 Steps to Reproduce + + + +1. Run the following command: + ```shell + YUTU_LOG_LEVEL=DEBUG yutu [command] [subcommand] [flags] + ``` +2. ... +3. Observe the error. + ``` + # Paste error output here + ``` + +### Expected Behavior + + + +## 📸 Screenshots or Logs + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index f3615ed..199420e 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,20 +1,76 @@ --- name: Feature request -about: Suggest an idea for this project -title: "[FEAT]" +about: Suggest an idea for yutu +title: "[FEAT] " labels: enhancement assignees: '' --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +## 🚀 Feature Request -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +### 📝 Feature Summary + -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +### 🎯 Motivation -**Additional context** -Add any other context or screenshots about the feature request here. +#### Problem Statement + + + + +#### Use Case + + +### 💡 Proposed Solution + + + +#### Example Usage + +```shell +# Show how the feature would work with example commands +yutu [new-command] [new-subcommand] [flags] +``` + +#### Expected Output + +``` +# What would the output look like? +``` + +### 🔄 Alternatives Considered + + + +1. **Alternative 1**: +2. **Alternative 2**: + +### 📊 Impact Assessment + +#### Benefits + +- [ ] Improves user experience +- [ ] Adds new YouTube API functionality +- [ ] Enhances MCP server capabilities +- [ ] Improves performance +- [ ] Other: + +#### Scope + +- [ ] New command/subcommand +- [ ] Enhancement to existing command +- [ ] Configuration change +- [ ] Documentation update +- [ ] Other: + +### 🔗 Related Information + +#### YouTube API Reference + + +- API Endpoint: + +#### Similar Features + +