Skip to content

🐛 Bug - Screenshot caption missing + duplicated screenshots in generated issues #834

@KostaMadorsky

Description

@KostaMadorsky

Cc: @calumjs @ricksu978 @adamcogan
Hi YakShaver Desktop team

🟥 Watch the video (1 min 12 sec)

Pain

Issues created by YakShaver Desktop are formatting screenshots incorrectly:

  • The screenshot at the top of the issue is missing the required caption text (e.g. “Figure: …”) underneath the image.
  • The caption text should be bold and visually prominent (currently missing / not bold).
  • The same screenshot is being duplicated (appears at the top of the issue and again in the “### Screenshots” section), creating clutter and confusion.

Reproduce Steps

  1. Use YakShaver Desktop to shave an issue into GitHub
  2. View the created issue on GitHub.
  3. Observe the screenshot added in two places: at the top, in the screenshots section

Expected Behavior

  • The screenshot is shown once in the issue body.
  • The screenshot has a bold caption underneath it (e.g. Figure: ...) describing what is shown.
  • The “### Screenshots” section does not contain a duplicated copy of the same screenshot when it is already embedded earlier in the issue.

Acceptance Criteria

  • Screenshot embedded by YakShaver Desktop includes a bold caption underneath (e.g. Figure: ...) describing the image
  • Caption text is visually prominent (matches the current/expected formatting shown in the “Screenshots section” example)
  • The same screenshot is not inserted twice in the generated issue body
  • Creating an issue with one screenshot results in exactly one rendered screenshot in the final GitHub issue

Tasks

  • Investigate how YakShaver Desktop generates screenshot markdown and captions
  • Identify why the caption text is missing under the top screenshot
  • Update screenshot rendering to include a bold “Figure:” caption under the image
  • Identify why screenshots are duplicated between the top of the issue and the “### Screenshots” section
  • Remove/avoid duplicate insertion of the same screenshot in generated issues
  • Add/adjust tests to cover screenshot caption formatting
  • Add/adjust tests to cover screenshot duplication prevention
  • Verify the fix by creating a new issue via YakShaver Desktop

More Information

Reporter notes:

  • A screenshot manually added in the “### Screenshots” section shows the desired result (it includes a Figure text/caption underneath describing what is in the screenshot).

Environment

  • Device: N/A
  • Browser: N/A
  • OS: N/A

Screenshots

YakShaver issue shows screenshot without caption and with duplication

Thanks!

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type: BugA problem with existing functionalityYakShaver

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions