Add GitHub issue templates and labels configuration#137
Add GitHub issue templates and labels configuration#137LittleLittleCloud merged 4 commits intomainfrom
Conversation
Co-authored-by: LittleLittleCloud <16876986+LittleLittleCloud@users.noreply.github.com>
Co-authored-by: LittleLittleCloud <16876986+LittleLittleCloud@users.noreply.github.com>
LittleLittleCloud
left a comment
There was a problem hiding this comment.
@copilot Address the comments
| description: Report a bug or unexpected behavior in RazorConsole | ||
| title: "[Bug]: " | ||
| labels: ["bug"] | ||
| body: |
There was a problem hiding this comment.
When reporting a bug, asking user to share cli info from razor console gallery app
There was a problem hiding this comment.
Updated the bug report template to reference the CLI Info page from the RazorConsole Gallery app. The Environment section now guides users to run dotnet run --project src/RazorConsole.Gallery and navigate to the "CLI Info" page to get comprehensive system and terminal information. (5765549)
Co-authored-by: LittleLittleCloud <16876986+LittleLittleCloud@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR implements GitHub issue templates and labels configuration to improve the issue reporting process. It adds structured YAML templates for bug reports and feature requests, defines repository labels, updates documentation, and provides guidance for contributors.
Key changes include:
- Two issue templates (bug report and feature request) with structured fields to gather comprehensive information
- Labels configuration file defining four labels: bug, feature-request, contribution-requested, and docs
- Updated CONTRIBUTING.md to reference the new issue templates
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| CONTRIBUTING.md | Added references to new issue templates and guidance on using repository labels |
| .github/labels.yml | Defines repository labels with names, descriptions, and colors for consistent issue categorization |
| .github/ISSUE_TEMPLATE/bug-report.yml | Structured bug report template with fields for description, reproduction steps, expected/actual behavior, and environment details (references RazorConsole Gallery CLI Info page) |
| .github/ISSUE_TEMPLATE/feature-request.yml | Structured feature request template with fields for description, problem statement, proposed solution, alternatives, and contribution willingness |
| .github/ISSUE_TEMPLATE/config.yml | Configures issue creation experience with links to Discussions and Documentation |
| .github/ISSUE_TEMPLATE/README.md | Documentation explaining the issue templates, labels setup instructions, and usage guidance |
| - **Bug Report**: For reporting bugs or unexpected behavior ([use template](../../issues/new?template=bug-report.yml)) | ||
| - **Feature Request**: For suggesting new features or enhancements ([use template](../../issues/new?template=feature-request.yml)) |
There was a problem hiding this comment.
The relative paths to issue templates are incorrect. The paths ../../issues/new?template=... assume the file is nested two directories deep from the repository root, but CONTRIBUTING.md is in the root directory. These links will not work correctly on GitHub.
Solution: Use absolute GitHub paths instead:
- **Bug Report**: For reporting bugs or unexpected behavior ([use template](https://github.com/LittleLittleCloud/RazorConsole/issues/new?template=bug-report.yml))
- **Feature Request**: For suggesting new features or enhancements ([use template](https://github.com/LittleLittleCloud/RazorConsole/issues/new?template=feature-request.yml))| - **Bug Report**: For reporting bugs or unexpected behavior ([use template](../../issues/new?template=bug-report.yml)) | |
| - **Feature Request**: For suggesting new features or enhancements ([use template](../../issues/new?template=feature-request.yml)) | |
| - **Bug Report**: For reporting bugs or unexpected behavior ([use template](https://github.com/LittleLittleCloud/RazorConsole/issues/new?template=bug-report.yml)) | |
| - **Feature Request**: For suggesting new features or enhancements ([use template](https://github.com/LittleLittleCloud/RazorConsole/issues/new?template=feature-request.yml)) |
Implemented GitHub issue templates and labels configuration:
.github/ISSUE_TEMPLATE/directoryRecent Update:
Updated the bug report template's Environment section to guide users to run the RazorConsole Gallery app and navigate to the "CLI Info" page, which provides comprehensive system and terminal information including OS architecture, .NET framework, terminal capabilities, and more. This helps users provide detailed environment information when reporting bugs.
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.