Conversation
|
Coverage after merging config-github-add-issue-and-pr-templates into main will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shouze
changed the title
shouze
force-pushed
the
config-github-add-issue-and-pr-templates
branch
from
c549748 to
1b2cf64
Compare
|
Coverage after merging config-github-add-issue-and-pr-templates into main will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
There was a problem hiding this comment.
Pull request overview
This PR adds GitHub issue and pull request templates to standardize contributions. The templates provide structured forms for bug reports, feature requests, and pull requests, making it easier for contributors to provide necessary information and for maintainers to triage issues effectively.
Changes:
- Added pull request template with two key questions about the PR's purpose and verification
- Added issue template configuration allowing blank issues
- Added bug report template with structured fields for version, reproduction steps, expected vs actual behavior
- Added feature request template with fields for problem statement, proposed solution, and alternatives
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| .github/pull_request_template.md | Simple PR template asking what the PR does and how the code was verified |
| .github/ISSUE_TEMPLATE/config.yml | Configuration file enabling blank issues alongside structured templates |
| .github/ISSUE_TEMPLATE/2-bug-report.yml | Structured bug report form with fields for version, reproduction steps, expected/actual behavior, and additional context |
| .github/ISSUE_TEMPLATE/1-feature-request.yml | Feature request form asking for problem statement, proposed solution, and alternatives considered |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - type: textarea | ||
| attributes: | ||
| label: What steps can reproduce the bug? | ||
| description: Explain the bug and provide a code snippet that can reproduce it. |
There was a problem hiding this comment.
The description asks users to "provide a code snippet that can reproduce it", but since github-code-search is a CLI tool rather than a library, this phrasing might be confusing. Consider changing this to "provide the exact command and steps that reproduce the bug" to better align with the CLI nature of the tool and match the guidance in CONTRIBUTING.md (lines 99-100) which asks for "The exact command you ran".
| description: Explain the bug and provide a code snippet that can reproduce it. | |
| description: Explain the bug and provide the exact command and steps that reproduce it. |
1 participant
No description provided.