Generated banner for Pr Screenshots
Generated logo for Pr Screenshots

Pr Screenshots

SentryOfficialPublished by Sentry

  • Skill
  • Guidelines
  • Software development
  • Apache-2.0
  • No issues found

From the author

Capture screenshots of the Sentry UI in a web browser, lay them out in a pull request description as before/after tables, and upload them with `gh --attach`.
— the description by Sentry

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill provides a rigorous workflow for documenting frontend UI changes in pull requests. By capturing consistent before-and-after screenshots from the actual application, developers can provide reviewers with clear, verifiable evidence of visual modifications. The process covers identifying relevant UI states, capturing images with identical framing, redacting sensitive information, and using command-line tools to attach these assets directly to the PR description.

What it does

  • Identifies all UI locations and states affected by a code change.
  • Defines strict standards for capturing screenshots from the live application.
  • Provides a redaction protocol to protect sensitive data while maintaining context.
  • Standardizes the layout of visual evidence using Markdown tables for Changed and Unchanged states.
  • Automates the attachment of images to pull requests using command-line interface tools.
  • Ensures visual documentation remains synchronized with the latest code changes.

When to use it

  • When a pull request includes intentional modifications to the frontend UI.
  • When you need to provide visual proof of a fix or feature to reviewers.
  • When documenting UI behavior across different states like loading, error, or theme variations.

Advantages

  • Reduces ambiguity for reviewers by providing clear visual context.
  • Ensures consistent, professional presentation of UI changes.
  • Maintains security by enforcing a redaction and audit step for sensitive data.
  • Integrates directly into the PR workflow without requiring manual browser uploads.

Usage examples

“How should I document the visual changes for my PR that updates the logs page?”
The agent will guide you to identify all affected states (e.g., loading, empty), capture before/after shots, redact sensitive data, and format them into a Changed table for your PR body.
“I have a new feature that doesn't have a 'before' state, how do I list it?”
The agent will instruct you to use an 'After' format, potentially using a Location | Screenshot table to present the new UI elements clearly.

Install

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/getsentry/pr-screenshots/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip pr-screenshots.zip -d .agents/skills

Documentation by Sentry

PR Screenshots

Screenshots in a PR are QA evidence. Each one shows what the real product renders at one location, framed so a reviewer who has never opened the page can tell what changed.

Step 1: List the Locations

List every place in the product that the diff reaches: each page, drawer, modal, or widget that renders a changed component, found by tracing its callers and consumers. Then add the states the change affects at each of them, such as loading, error, empty, hover, selected, menu open, expanded, scrolled, narrow viewport, and light or dark theme.

Never group surfaces into one row: for example, "GridEditable, as in Discover, dashboards and insights" is three rows.

Step 2: Capture From the Real Product

RuleDetail
Real build onlyScreenshot the running app on the PR branch for "after" and on the base branch for "before". Never screenshot a story, mock page, or harness built for the PR, unless the change is to that story.
No injected changesNever inject CSS or change the DOM to imitate the change. Stubbing API responses is fine; the frontend code must be the real code.
Seed missing dataIf a state needs data no account has, create it in a local environment. Do not report a location as impossible to screenshot until seeding has been tried, and then say exactly what failed.
Identical framingCapture the same region at the same dimensions for both shots of a pair, even when one state is taller. Emulate a fixed viewport instead of resizing the user's own browser window.
ContextKeep the heading or label that names the thing, nearby rows or controls, and a little padding on every side. For a hover, focus, or open-menu state, keep the trigger and the overlay in one frame. When the bug only makes sense in its page, show more of the page.
No empty bandsCrop out browser chrome, app navigation, and regions the change does not touch. For full-width layouts, shrink the viewport instead of leaving wide blank space beside short content.

Step 3: Redact and Audit

  1. Blur only private values: emails, usernames, customer or organization names and slugs, IDs, and internal hostnames. Keep keys, labels, and non-sensitive values readable, such as browser.name → chrome.

  2. Paint over each region before blurring it so the blur can't be reversed. Never use solid black or dark boxes, and never blur whole tables or rows.

  3. Read every image before uploading it and check for credentials: tokens, auth headers, cookies, signed URLs, secret keys, and webhook endpoints. Remove real leaks. Do not treat a public client DSN as a leak.

Step 4: Choose the Table Shape

ChangeShape
Visual change to existing UIChanged table, plus an Unchanged table for locations the diff reaches that render the same.
New page or featureNo before/after. A few "after" screenshots, each introduced by a short sentence. When the new UI appears in several locations, use a Location | Screenshot table instead.
Alternatives with no "before", such as prototype treatments or design optionsTreatment | Screenshot table, one row per alternative.
A change that differs by themeAdd a light and a dark row for each location, such as Explore › Logs, dark. For new UI, use Light | Dark columns instead.

Pixel-diff every before/after pair. Move a pair with no visible difference, including anti-aliasing noise, to Unchanged with one image. Leave out a table that would be empty.

**Changed**

| Location | Before | After |
| --- | --- | --- |
| Explore › Logs | ![Explore › Logs before](./shots/logs-before.png) | ![Explore › Logs after](./shots/logs-after.png) |
| Explore › Logs, loading | ![Explore › Logs, loading before](./shots/logs-loading-before.png) | ![Explore › Logs, loading after](./shots/logs-loading-after.png) |

**Unchanged**

| Location | Before & After |
| --- | --- |
| Trace view › Logs | ![Trace view › Logs](./shots/trace-logs.png) |

Formatting rules:

  • Name the first column Location, or Treatment for alternatives. Never leave its header empty.

  • Write each location as a › breadcrumb of what the reader clicks through, then a comma and the state: Monitors › cron monitor details › Check-Ins, loading.

  • Use only the columns shown above. Never add a "What changed" or notes column; the screenshots show the change.

  • Give each image alt text naming its row and side, such as Explore › Logs before.

  • Label the tables with bold **Changed** and **Unchanged** lines. Do not add an intro sentence describing where or how the screenshots were taken.

  • Use Markdown tables by default, because gh --attach rewrites only Markdown image references. Switch to an HTML table only when cells must span rows, such as a light and dark row under one location (Location | Theme | Before | After with rowspan="2" on the location cell). Do not add align attributes.

Step 5: Upload With gh

gh pr create, gh pr edit, gh pr comment, and the matching gh issue commands accept --attach '<path>#<alt text>' (gh 2.99.0+). If gh rejects the flag, ask the user to upgrade it. Do not push asset branches, commit images, or upload through the browser's comment box.

Write the body file with relative Markdown image references, then pass the same paths to --attach. gh uploads each file and rewrites the matching reference to the uploaded URL in place:

gh pr edit 123 --body-file pr-body.md \
  --attach './shots/logs-before.png' --attach './shots/logs-after.png'
BehaviorDetail
PathsResolve against the current directory, and must match the body's references exactly.
Unreferenced attachmentsGet appended to the end of the body as ![alt](url).
No body flaggh pr edit --attach keeps the existing body and appends the images.
HTML tables<img src="./x.png"> is not rewritten. Attach first, copy the appended URLs into the <img> tags, delete the appended lines, then write the final body with --body-file.

Before writing a body the user may have edited, fetch it again and compare it with the version you last read. Keep the user's wording and table edits, swap in only your rows and URLs, and keep the body's line endings. Removing an image from the body does not delete the uploaded file.

Step 6: Keep Screenshots Current

When a later commit changes what a screenshot shows, retake the affected pairs, re-check which pairs belong in Changed and Unchanged, and update the body without waiting to be asked.

Files

LICENSE

                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to the Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   Copyright 2025 Functional Software, Inc. dba Sentry

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Needs a command-line tool

Security

No issues found by our static scan· No issues found

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Published by
Sentry
Publisher
Sentry (Official)
Source
getsentry/skills · skills/pr-screenshots · commit e94f222
Licence
Apache License 2.0 (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Sentry.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download pr-screenshots.zip