Skip to content

docs(chore): improve the bug report template #364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 1, 2025
Merged

docs(chore): improve the bug report template #364

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9c847b6
docs(chore): improve the bug report template
kurosakishigure Mar 1, 2025
3723647
docs(chore): separate the part that provides the link
kurosakishigure Mar 1, 2025
f23f12d
Merge branch 'canary' into docs/chore
kurosakishigure Mar 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .github/ISSUE_TEMPLATE/bug.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,23 @@ body:
attributes:
label: Katharsis Version
description: What is the version number of your Katharsis?
placeholder: for example, v1.0.0
placeholder: for example, 1.0.0
validations:
required: true
- type: input
id: system_version
attributes:
label: System Version
description: What is your system version?
placeholder: for example, macOS v15.1.1
placeholder: for example, macOS 15.1.1
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.'
Copy link
Preview

Copilot AI Mar 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

Suggested change
value: '1.'
placeholder: 'Step-by-step instructions to reproduce the issue'

Copilot uses AI. Check for mistakes.

validations:
required: true
- type: textarea
Expand Down