Skip to content

chore: Made bug report allow screenshots#404

Merged
PartyDonut merged 2 commits intoDonutWare:developfrom
schembriaiden:fix-issue-template
Jul 13, 2025
Merged

chore: Made bug report allow screenshots#404
PartyDonut merged 2 commits intoDonutWare:developfrom
schembriaiden:fix-issue-template

Conversation

@schembriaiden
Copy link
Copy Markdown
Contributor

@schembriaiden schembriaiden commented Jun 30, 2025

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

  • If a new package was added, did you ensure it works for all supported platforms? Is the package well maintained
  • Check that any changes are related to the issue at hand.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Jun 30, 2025

Reviewer's Guide

This 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 fields

classDiagram
    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'
Loading

File-Level Changes

Change Details Files
Simplified the default issue title
  • Removed the embedded <title> placeholder from the title field
  • Updated title key to leave content empty by default
.github/ISSUE_TEMPLATE/bug-report.yml
Enabled direct screenshot paste/drag-and-drop
  • Removed the multiline value block previously used for screenshot hints
  • Removed the render: bash directive
  • Added a placeholder instructing users to drag, drop, or use markdown image links
.github/ISSUE_TEMPLATE/bug-report.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

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: |
-        ![DESCRIPTION](LINK.png)
-      render: bash
+      placeholder: "Drag and drop screenshots here, or paste image URLs using ![description](image-url)"
     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 ![description](image-url)"
=======
      placeholder: "Drag and drop screenshots here, or paste image URLs using ![description](image-url)\n\nExample: ![Error dialog](https://example.com/error.png)"
>>>>>>> REPLACE

</suggested_fix>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Copy Markdown
Collaborator

@PartyDonut PartyDonut left a comment

Choose a reason for hiding this comment

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

Makes sense, where a lot of issues reported with broken screenshots.

@PartyDonut PartyDonut merged commit 6f6ae76 into DonutWare:develop Jul 13, 2025
1 check passed
@schembriaiden schembriaiden deleted the fix-issue-template branch July 13, 2025 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants