Expand issue templates from 3 to 7 types (#26)
- Add Security template for vulnerability reporting - Add Performance template for performance issues - Add Enhancement template for existing feature improvements - Add Discussion template for general discussions - Add Question template for usage questions - Update project-management workflow to recognize all 7 types - Update all templates to show complete list of 7 issue types 🤖 Generated with [Claude Code](https://claude.ai/code) Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
JessyTsui
GitHub
parent
bd35dfdacf
commit
eafe594a66
|
|
@ -27,7 +27,11 @@ Format: [BUG] Short clear description of the problem
|
|||
📋 AVAILABLE ISSUE TYPES:
|
||||
1. 🐛 Bug Report (this template) - Report broken functionality
|
||||
2. ✨ Feature Request - Request new features
|
||||
3. Create Discussion instead for questions
|
||||
3. ❓ Question - Ask usage questions
|
||||
4. 🔒 Security Report - Report security vulnerabilities
|
||||
5. ⚡ Performance Issue - Report performance problems
|
||||
6. 🔧 Enhancement - Suggest improvements to existing features
|
||||
7. 💬 Discussion - General discussions and brainstorming
|
||||
-->
|
||||
|
||||
## Bug Type (select one)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,67 @@
|
|||
---
|
||||
name: 💬 Discussion
|
||||
about: General discussions and brainstorming
|
||||
title: '[DISCUSSION] '
|
||||
labels: 'discussion'
|
||||
---
|
||||
|
||||
<!--
|
||||
🏷️ ISSUE TITLE NAMING RULES:
|
||||
Format: [DISCUSSION] Short description of the discussion topic
|
||||
|
||||
✅ GOOD EXAMPLES:
|
||||
- [DISCUSSION] Should we support WhatsApp integration?
|
||||
- [DISCUSSION] Best practices for notification rate limiting
|
||||
- [DISCUSSION] Architecture discussion for multi-tenant support
|
||||
- [DISCUSSION] Ideas for improving user onboarding
|
||||
- [DISCUSSION] Feedback on new configuration format
|
||||
- [DISCUSSION] Community guidelines for contributors
|
||||
- [DISCUSSION] Roadmap planning for next major version
|
||||
|
||||
❌ BAD EXAMPLES:
|
||||
- Discussion (no [DISCUSSION] prefix)
|
||||
- [DISCUSSION] Question (use [QUESTION] for specific questions)
|
||||
- Ideas (no [DISCUSSION] prefix)
|
||||
- [DISCUSSION] Help (use [QUESTION] for help requests)
|
||||
|
||||
📋 AVAILABLE ISSUE TYPES:
|
||||
1. 🐛 Bug Report - Report broken functionality
|
||||
2. ✨ Feature Request - Request new features
|
||||
3. ❓ Question - Ask usage questions
|
||||
4. 🔒 Security Report - Report security vulnerabilities
|
||||
5. ⚡ Performance Issue - Report performance problems
|
||||
6. 🔧 Enhancement - Suggest improvements to existing features
|
||||
7. 💬 Discussion (this template) - General discussions and brainstorming
|
||||
-->
|
||||
|
||||
## Discussion Topic
|
||||
<!-- What would you like to discuss? -->
|
||||
|
||||
## Context/Background
|
||||
<!-- Provide relevant background information -->
|
||||
|
||||
## Key Questions
|
||||
<!-- What specific questions should we consider? -->
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
## Potential Options/Ideas
|
||||
<!-- What are some possible approaches or solutions? -->
|
||||
- Option A:
|
||||
- Option B:
|
||||
- Option C:
|
||||
|
||||
## Impact/Considerations
|
||||
<!-- What should we keep in mind? -->
|
||||
- **Users**:
|
||||
- **Development**:
|
||||
- **Maintenance**:
|
||||
- **Performance**:
|
||||
|
||||
## Looking for
|
||||
- [ ] Community feedback and opinions
|
||||
- [ ] Technical input from maintainers
|
||||
- [ ] Ideas and suggestions
|
||||
- [ ] Help with decision making
|
||||
- [ ] Brainstorming session
|
||||
|
|
@ -0,0 +1,61 @@
|
|||
---
|
||||
name: 🔧 Enhancement
|
||||
about: Suggest improvements to existing features
|
||||
title: '[ENHANCEMENT] '
|
||||
labels: 'enhancement'
|
||||
---
|
||||
|
||||
<!--
|
||||
🏷️ ISSUE TITLE NAMING RULES:
|
||||
Format: [ENHANCEMENT] Short description of the enhancement
|
||||
|
||||
✅ GOOD EXAMPLES:
|
||||
- [ENHANCEMENT] Improve error messages for failed notifications
|
||||
- [ENHANCEMENT] Add configuration validation on startup
|
||||
- [ENHANCEMENT] Better logging for debugging command execution
|
||||
- [ENHANCEMENT] Improve Telegram bot command help text
|
||||
- [ENHANCEMENT] Add retry mechanism for failed email sends
|
||||
- [ENHANCEMENT] Better handling of network timeouts
|
||||
- [ENHANCEMENT] Improve notification formatting options
|
||||
|
||||
❌ BAD EXAMPLES:
|
||||
- Enhancement (no [ENHANCEMENT] prefix)
|
||||
- [ENHANCEMENT] Better (not specific enough)
|
||||
- Improve something (no [ENHANCEMENT] prefix)
|
||||
- [ENHANCEMENT] Fix (use [BUG] for fixes)
|
||||
|
||||
📋 AVAILABLE ISSUE TYPES:
|
||||
1. 🐛 Bug Report - Report broken functionality
|
||||
2. ✨ Feature Request - Request new features
|
||||
3. ❓ Question - Ask usage questions
|
||||
4. 🔒 Security Report - Report security vulnerabilities
|
||||
5. ⚡ Performance Issue - Report performance problems
|
||||
6. 🔧 Enhancement (this template) - Suggest improvements to existing features
|
||||
7. 💬 Discussion - General discussions and brainstorming
|
||||
-->
|
||||
|
||||
## What feature needs enhancement?
|
||||
<!-- Which existing feature should be improved? -->
|
||||
|
||||
## Current behavior
|
||||
<!-- How does it work now? -->
|
||||
|
||||
## Suggested improvement
|
||||
<!-- What should be enhanced and how? -->
|
||||
|
||||
## Why is this enhancement needed?
|
||||
<!-- What problem does this solve? -->
|
||||
|
||||
## Priority
|
||||
- [ ] Nice to have
|
||||
- [ ] Would improve user experience
|
||||
- [ ] Important for workflow
|
||||
- [ ] Critical improvement needed
|
||||
|
||||
## Implementation suggestions (optional)
|
||||
<!-- If you have ideas on how to implement this -->
|
||||
|
||||
## Environment
|
||||
- **Node version**:
|
||||
- **OS**:
|
||||
- **Platform**: Email / Telegram / LINE / All
|
||||
|
|
@ -28,7 +28,11 @@ Format: [FEATURE] Short clear description of the feature
|
|||
📋 AVAILABLE ISSUE TYPES:
|
||||
1. 🐛 Bug Report - Report broken functionality
|
||||
2. ✨ Feature Request (this template) - Request new features
|
||||
3. Create Discussion instead for questions
|
||||
3. ❓ Question - Ask usage questions
|
||||
4. 🔒 Security Report - Report security vulnerabilities
|
||||
5. ⚡ Performance Issue - Report performance problems
|
||||
6. 🔧 Enhancement - Suggest improvements to existing features
|
||||
7. 💬 Discussion - General discussions and brainstorming
|
||||
-->
|
||||
|
||||
## Feature Type (select one)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,78 @@
|
|||
---
|
||||
name: ⚡ Performance Issue
|
||||
about: Report performance problems
|
||||
title: '[PERFORMANCE] '
|
||||
labels: 'performance'
|
||||
---
|
||||
|
||||
<!--
|
||||
🏷️ ISSUE TITLE NAMING RULES:
|
||||
Format: [PERFORMANCE] Short description of the performance issue
|
||||
|
||||
✅ GOOD EXAMPLES:
|
||||
- [PERFORMANCE] Email notifications take too long to send
|
||||
- [PERFORMANCE] High memory usage during command execution
|
||||
- [PERFORMANCE] Telegram bot response time over 5 seconds
|
||||
- [PERFORMANCE] Application startup takes too long
|
||||
- [PERFORMANCE] CPU usage spikes during notification processing
|
||||
- [PERFORMANCE] Database queries running slowly
|
||||
- [PERFORMANCE] Large file uploads causing timeout
|
||||
|
||||
❌ BAD EXAMPLES:
|
||||
- Performance issue (no [PERFORMANCE] prefix)
|
||||
- [PERFORMANCE] Slow (not specific enough)
|
||||
- App is slow (no [PERFORMANCE] prefix)
|
||||
- [PERFORMANCE] Problem (too vague)
|
||||
|
||||
📋 AVAILABLE ISSUE TYPES:
|
||||
1. 🐛 Bug Report - Report broken functionality
|
||||
2. ✨ Feature Request - Request new features
|
||||
3. ❓ Question - Ask usage questions
|
||||
4. 🔒 Security Report - Report security vulnerabilities
|
||||
5. ⚡ Performance Issue (this template) - Report performance problems
|
||||
6. 🔧 Enhancement - Suggest improvements to existing features
|
||||
7. 💬 Discussion - General discussions and brainstorming
|
||||
-->
|
||||
|
||||
## Performance Issue Type (select one)
|
||||
- [ ] Slow response time
|
||||
- [ ] High memory usage
|
||||
- [ ] High CPU usage
|
||||
- [ ] Long startup time
|
||||
- [ ] Database performance
|
||||
- [ ] Network latency
|
||||
- [ ] File I/O performance
|
||||
|
||||
## Current behavior
|
||||
<!-- What is happening now? Include metrics if available -->
|
||||
|
||||
## Expected performance
|
||||
<!-- What should the performance be? -->
|
||||
|
||||
## When does this occur?
|
||||
- [ ] Always
|
||||
- [ ] During high load
|
||||
- [ ] With specific commands
|
||||
- [ ] With large files/data
|
||||
- [ ] At startup
|
||||
- [ ] Other:
|
||||
|
||||
## Performance metrics (if available)
|
||||
- **Response time**:
|
||||
- **Memory usage**:
|
||||
- **CPU usage**:
|
||||
- **Load time**:
|
||||
|
||||
## Steps to reproduce
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
## Environment
|
||||
- **Node version**:
|
||||
- **OS**:
|
||||
- **Platform**: Email / Telegram / LINE / All
|
||||
- **System specs**:
|
||||
|
||||
## Additional context
|
||||
<!-- Any other information about the performance issue -->
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
---
|
||||
name: ❓ Question
|
||||
about: Ask usage questions
|
||||
title: '[QUESTION] '
|
||||
labels: 'question'
|
||||
---
|
||||
|
||||
<!--
|
||||
🏷️ ISSUE TITLE NAMING RULES:
|
||||
Format: [QUESTION] Short description of your question
|
||||
|
||||
✅ GOOD EXAMPLES:
|
||||
- [QUESTION] How to configure Telegram bot with custom commands?
|
||||
- [QUESTION] Can I use multiple email accounts for notifications?
|
||||
- [QUESTION] How to set up LINE webhook for notifications?
|
||||
- [QUESTION] What Node.js versions are supported?
|
||||
- [QUESTION] How to troubleshoot failed email notifications?
|
||||
- [QUESTION] Can notifications be scheduled for specific times?
|
||||
- [QUESTION] How to configure environment variables on Windows?
|
||||
|
||||
❌ BAD EXAMPLES:
|
||||
- Question (no [QUESTION] prefix)
|
||||
- [QUESTION] Help (not specific enough)
|
||||
- How to setup (no [QUESTION] prefix)
|
||||
- [QUESTION] Problem (use [BUG] for problems)
|
||||
|
||||
📋 AVAILABLE ISSUE TYPES:
|
||||
1. 🐛 Bug Report - Report broken functionality
|
||||
2. ✨ Feature Request - Request new features
|
||||
3. ❓ Question (this template) - Ask usage questions
|
||||
4. 🔒 Security Report - Report security vulnerabilities
|
||||
5. ⚡ Performance Issue - Report performance problems
|
||||
6. 🔧 Enhancement - Suggest improvements to existing features
|
||||
7. 💬 Discussion - General discussions and brainstorming
|
||||
-->
|
||||
|
||||
## Question Category (select one)
|
||||
- [ ] Installation and setup
|
||||
- [ ] Configuration
|
||||
- [ ] Platform integration (Email/Telegram/LINE)
|
||||
- [ ] Command usage
|
||||
- [ ] Troubleshooting
|
||||
- [ ] Best practices
|
||||
|
||||
## Your Question
|
||||
<!-- What do you want to know? -->
|
||||
|
||||
## What have you tried?
|
||||
<!-- What steps have you already taken? -->
|
||||
|
||||
## Context
|
||||
<!-- Provide relevant details about your setup -->
|
||||
|
||||
## Environment (if relevant)
|
||||
- **Node version**:
|
||||
- **OS**:
|
||||
- **Platform**: Email / Telegram / LINE / All
|
||||
|
||||
## Additional Information
|
||||
<!-- Any other relevant information -->
|
||||
|
|
@ -0,0 +1,69 @@
|
|||
---
|
||||
name: 🔒 Security Report
|
||||
about: Report a security vulnerability
|
||||
title: '[SECURITY] '
|
||||
labels: 'security'
|
||||
---
|
||||
|
||||
<!--
|
||||
🏷️ ISSUE TITLE NAMING RULES:
|
||||
Format: [SECURITY] Short description of the security issue
|
||||
|
||||
✅ GOOD EXAMPLES:
|
||||
- [SECURITY] Hardcoded credentials in config file
|
||||
- [SECURITY] Command injection vulnerability in email handler
|
||||
- [SECURITY] Exposed API keys in environment variables
|
||||
- [SECURITY] Unauthorized access to notification settings
|
||||
- [SECURITY] XSS vulnerability in notification content
|
||||
- [SECURITY] Path traversal in file upload feature
|
||||
- [SECURITY] SQL injection in database queries
|
||||
|
||||
❌ BAD EXAMPLES:
|
||||
- Security issue (no [SECURITY] prefix)
|
||||
- [SECURITY] Problem (not descriptive enough)
|
||||
- Vulnerability (no [SECURITY] prefix)
|
||||
- [SECURITY] Bug (too vague)
|
||||
|
||||
📋 AVAILABLE ISSUE TYPES:
|
||||
1. 🐛 Bug Report - Report broken functionality
|
||||
2. ✨ Feature Request - Request new features
|
||||
3. ❓ Question - Ask usage questions
|
||||
4. 🔒 Security Report (this template) - Report security vulnerabilities
|
||||
5. ⚡ Performance Issue - Report performance problems
|
||||
6. 🔧 Enhancement - Suggest improvements to existing features
|
||||
7. 💬 Discussion - General discussions and brainstorming
|
||||
-->
|
||||
|
||||
## Severity Level (select one)
|
||||
- [ ] 🔴 Critical - Immediate action required
|
||||
- [ ] 🟠 High - Should be fixed soon
|
||||
- [ ] 🟡 Medium - Should be addressed
|
||||
- [ ] 🟢 Low - Minor security concern
|
||||
|
||||
## Vulnerability Type (select one)
|
||||
- [ ] Authentication/Authorization
|
||||
- [ ] Code injection (Command/SQL/XSS)
|
||||
- [ ] Data exposure/leak
|
||||
- [ ] Hardcoded secrets/credentials
|
||||
- [ ] Input validation
|
||||
- [ ] Path traversal
|
||||
- [ ] Other
|
||||
|
||||
## Description
|
||||
<!-- Clear description of the security issue -->
|
||||
|
||||
## Steps to reproduce
|
||||
1.
|
||||
2.
|
||||
3.
|
||||
|
||||
## Impact
|
||||
<!-- What could an attacker achieve? -->
|
||||
|
||||
## Suggested fix
|
||||
<!-- If you have suggestions for fixing this -->
|
||||
|
||||
## Environment
|
||||
- **Node version**:
|
||||
- **OS**:
|
||||
- **Platform**: Email / Telegram / LINE / All
|
||||
|
|
@ -37,6 +37,10 @@ jobs:
|
|||
if (title.includes('[bug]')) labels.push('type:bug');
|
||||
if (title.includes('[feature]')) labels.push('type:enhancement');
|
||||
if (title.includes('[question]')) labels.push('type:question');
|
||||
if (title.includes('[security]')) labels.push('type:security');
|
||||
if (title.includes('[performance]')) labels.push('type:performance');
|
||||
if (title.includes('[enhancement]')) labels.push('type:enhancement');
|
||||
if (title.includes('[discussion]')) labels.push('type:discussion');
|
||||
|
||||
if (labels.length > 0) {
|
||||
await github.rest.issues.addLabels({
|
||||
|
|
|
|||
Loading…
Reference in New Issue