docs: more templates for ISSUE.md

This commit is contained in:
2024-10-15 19:35:52 +00:00
parent de57b814a7
commit 8e782da75d
+101 -9
View File
@@ -79,7 +79,7 @@ Apply appropriate labels to categorize and prioritize issues.
- `revert`
- ### Priority:
- `priority: high`
- `priority: low`
- `priority: medium`
- `priority: high`
@@ -103,38 +103,130 @@ Assign issues to milestones to track progress toward releases or date.
When creating an issue, use the appropriate template:
### Bug Report
- ### Title: `Bug: <short description>`
- ### Template Sections:
- **Title**: `Bug: <short description>`
- **Template Sections**:
- Overview
- Steps to Reproduce
- Expected Behavior
- Actual Behavior
- Screenshots (if applicable)
- Environment (OS, software vesions if possible)
- **Labels**:
- `bug`
- `priority: {high|megium|low}`
- `status: needs triage`
### Feature Request
- ### Title: `Feature: <short description>`
- ### Template Sections:
- **Title*: `Feature: <short description>`
- **Template Sections**:
- Overview
- Motivation
- Proposed Solution
- Alternatives Considered
- Additional Context
- **Labels**:
- `feature`
- `priority: {high|megium|low}`
- `status: needs triage`
### Refactor Task
- ### Title `Refactor: <short description>`
- ### Template Sections:
- **Title** `Refactor: <short description>`
- **Template Sections**:
- Overview
- Reason for Refactoring
- Areas of Impact
- Expected Benefits
- **Labels**:
- `refactor`
- `priority: {high|megium|low}`
- `status: needs triage`
### Documentation Task
- ### Title: `Documentation: <short description>`
- ### Template Sections:
- **Title**: `Documentation: <short description>`
- **Template Sections**:
- Overview
- Pages or Sections Affected
- Proposed Changes
- **Labels**:
- `documentation`
- `priority: {high|megium|low}`
- `status: needs triage`
### Performance Improvement
- **Title**: `Performance: <short description>`
- **Template Sections**:
- Overview
- Current Performance
- Expected Performance
- Impact
- Additional Information
- **Labels**:
- `performance`
- `priority: {high|megium|low}`
- `status: needs triage`
### Test Task
- **Title**: `Test: <short description>`
- **Template Sections**:
- Overview
- Areas to Test
- Test Type
- Motivation
- Additional Context
- **Labels**:
- `test`
- `priority: {high|megium|low}`
- `status: needs triage`
### Build Task
- **Title**: `Build: <short description>`
- **Template Sections**:
- Overview
- Current Build Configuration
- Proposed Changes
- Reason for Change
- Impact
- **Labels**:
- `build`
- `priority: {high|megium|low}`
- `status: needs triage`
### CI Task
- **Title**: `CI: <short description>`
- **Template Sections**:
- Overview
- Current CI Setup
- Proposed Changes
- Motivation
- Impact
- **Labels**:
- `ci`
- `priority: {high|megium|low}`
- `status: needs triage`
### Chore Task
- **Title**: `Chore: <short description>`
- **Template Sections**:
- Overview
- Task Details
- Reasoning
- Impact
- **Labels**:
- `chore`
- `priority: {high|megium|low}`
- `status: needs triage`
### Revert Task
- **Title**: `Chore: <short description>`
- **Template Sections**:
- Overview
- Commit/PR to Revert
- Reason for Revert
- Impact
- **Labels**:
- `chore`
- `priority: {high|megium|low}`
- `status: needs triage`
## Referencing Issues and Pull Requests
- **Closing Issues Automatically**: Include keywords in pull requests to close issues automatically when merged