Skip to content

_#336

Merged
xtsea merged 2 commits into
betafrom
dev
Aug 27, 2025
Merged

_#336
xtsea merged 2 commits into
betafrom
dev

Conversation

@xtsea

@xtsea xtsea commented Aug 27, 2025

Copy link
Copy Markdown
Contributor

Summary by Sourcery

Add a GitHub issue template for bug reports and introduce a security policy document.

Documentation:

  • Add .github/ISSUE_TEMPLATE/bug_report.md to guide users in submitting detailed bug reports
  • Create SECURITY.md with supported version matrix and vulnerability reporting guidelines

@sourcery-ai

sourcery-ai Bot commented Aug 27, 2025

Copy link
Copy Markdown
Contributor

Reviewer's Guide

This PR adds a standardized bug report issue template and an initial security policy document by introducing two new markdown files with predefined sections for reporting bugs and vulnerabilities.

File-Level Changes

Change Details Files
Add bug report issue template
  • Define front matter with name, about, title, labels, and assignees
  • Add sections: Describe the bug, To Reproduce, Expected behavior, Screenshots, environment details, and Additional context
.github/ISSUE_TEMPLATE/bug_report.md
Add security policy document
  • Introduce supported versions table with status indicators
  • Provide reporting guidelines for vulnerabilities
SECURITY.md

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

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes and they look great!


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.

@xtsea xtsea merged commit 4d48fc6 into beta Aug 27, 2025
2 of 3 checks passed
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.

1 participant