chore: Made bug report allow screenshots#404
Merged
PartyDonut merged 2 commits intoDonutWare:developfrom Jul 13, 2025
Merged
Conversation
Contributor
Reviewer's GuideThis PR updates the bug-report issue template to streamline title handling and enable direct screenshot additions by replacing the bash render block with a markdown-friendly placeholder. Class diagram for updated bug report issue template fieldsclassDiagram
class BugReportTemplate {
- name: string
- description: string
- title: string
- labels: list
- type: string
- body: list
}
class ScreenshotField {
- label: string
- description: string
- placeholder: string
- validations: object
}
BugReportTemplate "1" *-- "1..*" ScreenshotField: contains
%% Note: ScreenshotField now uses 'placeholder' instead of 'render: bash' and 'value'
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Hey @vikingnope - I've reviewed your changes and they look great!
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location> `.github/ISSUE_TEMPLATE/bug-report.yml:3` </location>
<code_context>
name: "🐛 Bug Report"
description: Create a new ticket for a bug.
-title: "🐛 <title>"
+title: "🐛 "
labels: ["bug"]
type: "Bug"
</code_context>
<issue_to_address>
The default title is now just an emoji, which may reduce clarity for users.
Consider if this change might result in less descriptive bug titles, and whether you want to prompt users to provide more detail.
</issue_to_address>
<suggested_fix>
<<<<<<< SEARCH
title: "🐛 "
=======
title:
default: ""
description: "Short, descriptive title for this bug report"
placeholder: "🐛 Briefly describe the bug"
>>>>>>> REPLACE
</suggested_fix>
### Comment 2
<location> `.github/ISSUE_TEMPLATE/bug-report.yml:33` </location>
<code_context>
- value: |
- 
- render: bash
+ placeholder: "Drag and drop screenshots here, or paste image URLs using "
validations:
required: false
</code_context>
<issue_to_address>
The new placeholder is more user-friendly, but the removal of the default markdown example may reduce clarity for some users.
The previous value offered a clear markdown example, which could help users unfamiliar with the syntax. Consider including both the concise instruction and a concrete example to maximize clarity.
</issue_to_address>
<suggested_fix>
<<<<<<< SEARCH
placeholder: "Drag and drop screenshots here, or paste image URLs using "
=======
placeholder: "Drag and drop screenshots here, or paste image URLs using \n\nExample: "
>>>>>>> REPLACE
</suggested_fix>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
PartyDonut
approved these changes
Jul 13, 2025
Collaborator
PartyDonut
left a comment
There was a problem hiding this comment.
Makes sense, where a lot of issues reported with broken screenshots.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Description
Currently as the bug report is you can't really add screenshots to it since it is bash, now it has been fixed and should allow screenshots. I have also changed the title to not include the
<title>since I think it is more confusing personally. Should you want the former reverted let me know.I have also changed some of the descriptions, capitalization, and made the version required.
Issue Being Fixed
Removed the render bash command for screenshots
Screenshots / Recordings
Checklist