docs(chore): improve the bug report template #364
Conversation
Signed-off-by: Shigure Kurosaki <[email protected]>
There was a problem hiding this comment.
PR Overview
This pull request updates the bug report template by refining the placeholder examples and instructions to improve clarity for users when submitting bug reports.
- Updated version placeholders to remove the "v" prefix for consistency.
- Revised the system version example to simplify the format.
- Modified the "To Reproduce" field description and added a default value.
Reviewed Changes
| File | Description |
|---|---|
| .github/ISSUE_TEMPLATE/bug.yml | Updated placeholder examples and added default text. |
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: to_reproduce | ||
| attributes: | ||
| label: To Reproduce | ||
| description: A step-by-step description of how to reproduce the issue. If possible, we prefer reproduction via links. | ||
| description: A step-by-step description of how to reproduce the issue. We encourage you to provide a link for minimal reproduction. | ||
| value: '1.' |
There was a problem hiding this comment.
[nitpick] The default value '1.' for the reproduction steps might be confusing if users leave it unchanged. Consider using a placeholder or more instructive text to avoid incomplete reproduction instructions.
| value: '1.' | |
| placeholder: 'Step-by-step instructions to reproduce the issue' |
Copilot uses AI. Check for mistakes.
Signed-off-by: Shigure Kurosaki <[email protected]>
There was a problem hiding this comment.
PR Overview
This PR improves the bug report template by updating placeholders and adding an optional minimal reproduction link field.
- Updated version and system version placeholders for consistency
- Added a new field for a link to minimal reproduction code
- Added a default value for the reproduction steps field
Reviewed Changes
| File | Description |
|---|---|
| .github/ISSUE_TEMPLATE/bug.yml | Updated placeholders and added a minimal reproduction link field |
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
| id: minimal_reproduction_link | ||
| attributes: | ||
| label: Link to Minimal Reproduction Code for This Issue | ||
| description: If you decide to create your own minimal reproduction, please make sure test on canary. |
There was a problem hiding this comment.
[nitpick] The phrase 'please make sure test on canary' is grammatically unclear and may confuse users. Consider revising it for clarity, such as 'please ensure you test on the canary version.'
| description: If you decide to create your own minimal reproduction, please make sure test on canary. | |
| description: If you decide to create your own minimal reproduction, please ensure you test on the canary version. |
Copilot uses AI. Check for mistakes.
Signed-off-by: Shigure Kurosaki [email protected]
Summary of Changes
Description
Related Issue
Checklist
CONTRIBUTING.mdAdditional Notes
(if applicable)