Git Issue Management Guide
This skill outlines the best practices for managing issues, writing effective bug reports and feature requests, and streamlining the triage process.
Writing Effective Bug Reports
A good bug report helps developers reproduce and fix the issue quickly.
Essential Components
- Title: Clear and concise summary of the issue.
- Environment: OS, Browser, App Version, etc.
- Reproduction Steps: Step-by-step instructions to reproduce the bug.
- Expected Behavior: What should happen.
- Actual Behavior: What actually happens.
- Visual Proof: Screenshots, videos, or logs (if applicable).
Example
Title: Search bar returns 500 error when special characters are used
Steps to Reproduce:
- Go to the homepage.
- Enter
%$#@ in the search bar.
- Click "Search".
Expected: A "No results found" message or input validation error.
Actual: The page crashes and displays a 500 Internal Server Error.
Writing Feature Requests
Feature requests should clearly state the problem and the proposed solution.
Essential Components
- Problem Statement: What is the problem or limitation?
- Proposed Solution: How should the feature work?
- Alternatives Considered: What other options were evaluated?
- Additional Context: Any other information, like mockups or use cases.
Labeling Strategy
Use a consistent labeling strategy to categorize and prioritize issues.
Common Label Categories
- Type:
bug, enhancement, documentation, question
- Priority:
high, medium, low, critical
- Status:
triage, in-progress, blocked, needs-review
- Scope/Component:
frontend, backend, database, ui
Triage Process
- Review New Issues: Read through incoming issues regularly.
- Reproduce: Verify if bugs are reproducible.
- Labeling: Apply appropriate type, priority, and scope labels.
- Assignment: Assign the issue to a team member or milestone.
- Link to PRs: Ensure developers link pull requests to the issue using keywords (e.g.,
Fixes #123).
Checklist for Issue Creators
1---2name: git-issue-manager3description: GitHub/GitLab issue yönetimi için en iyi uygulamalar. Etkili hata raporları, özellik istekleri yazma ve etiketleme.4---56# Git Issue Management Guide78This skill outlines the best practices for managing issues, writing effective bug reports and feature requests, and streamlining the triage process.910## Writing Effective Bug Reports1112A good bug report helps developers reproduce and fix the issue quickly.1314### Essential Components151. **Title**: Clear and concise summary of the issue.162. **Environment**: OS, Browser, App Version, etc.173. **Reproduction Steps**: Step-by-step instructions to reproduce the bug.184. **Expected Behavior**: What should happen.195. **Actual Behavior**: What actually happens.206. **Visual Proof**: Screenshots, videos, or logs (if applicable).2122### Example23**Title**: Search bar returns 500 error when special characters are used24**Steps to Reproduce**:251. Go to the homepage.262. Enter `%$#@` in the search bar.273. Click "Search".28**Expected**: A "No results found" message or input validation error.29**Actual**: The page crashes and displays a 500 Internal Server Error.3031## Writing Feature Requests3233Feature requests should clearly state the problem and the proposed solution.3435### Essential Components361. **Problem Statement**: What is the problem or limitation?372. **Proposed Solution**: How should the feature work?383. **Alternatives Considered**: What other options were evaluated?394. **Additional Context**: Any other information, like mockups or use cases.4041## Labeling Strategy4243Use a consistent labeling strategy to categorize and prioritize issues.4445### Common Label Categories46- **Type**: `bug`, `enhancement`, `documentation`, `question`47- **Priority**: `high`, `medium`, `low`, `critical`48- **Status**: `triage`, `in-progress`, `blocked`, `needs-review`49- **Scope/Component**: `frontend`, `backend`, `database`, `ui`5051## Triage Process52531. **Review New Issues**: Read through incoming issues regularly.542. **Reproduce**: Verify if bugs are reproducible.553. **Labeling**: Apply appropriate type, priority, and scope labels.564. **Assignment**: Assign the issue to a team member or milestone.575. **Link to PRs**: Ensure developers link pull requests to the issue using keywords (e.g., `Fixes #123`).5859## Checklist for Issue Creators60- [ ] Did I search for existing issues to avoid duplicates?61- [ ] Is the title descriptive?62- [ ] Are the reproduction steps clear?63- [ ] Did I provide environment details?
GktuOktay