Skip to content

Create SECURITY.md#2

Merged
parkcheolhong merged 1 commit into
mainfrom
parkcheolhong-patch-1
Apr 15, 2026
Merged

Create SECURITY.md#2
parkcheolhong merged 1 commit into
mainfrom
parkcheolhong-patch-1

Conversation

@parkcheolhong
Copy link
Copy Markdown
Owner

@parkcheolhong parkcheolhong commented Apr 15, 2026

Summary by Sourcery

Documentation:

  • Add SECURITY.md describing supported versions and guidance for reporting security vulnerabilities.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Apr 15, 2026

Reviewer's Guide

Adds an initial SECURITY.md documenting supported versions and a template for reporting vulnerabilities.

Flow diagram for vulnerability reporting lifecycle described in SECURITY.md

flowchart TD
  A[Security researcher discovers vulnerability] --> B[Researcher opens SECURITY_md]
  B --> C[Check supported versions table]
  C --> D{Version supported?}
  D -->|Yes| E[Follow reporting instructions in SECURITY_md]
  D -->|No| F[Consider reporting with lower priority or informational context]
  E --> G[Project maintainers receive report]
  G --> H[Assess and triage vulnerability]
  H --> I{Vulnerability accepted?}
  I -->|Yes| J[Plan and implement fix for supported versions]
  I -->|No| K[Communicate decision and reasoning to reporter]
  J --> L[Publish fix and, if applicable, advisory]
  L --> M[Update SECURITY_md support table if needed]
Loading

File-Level Changes

Change Details Files
Introduce a SECURITY policy document to the repository root.
  • Create SECURITY.md with sections for Supported Versions and Reporting a Vulnerability
  • Document a sample version support matrix using markdown table syntax
  • Provide placeholder guidance text for how users should report vulnerabilities and what to expect
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

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 - I've left some high level feedback:

  • The SECURITY.md still contains placeholder template text (e.g., “Use this section to tell people...”)—replace these with concrete project-specific guidance on supported versions and security update policy.
  • The reporting section should be updated with an actual vulnerability reporting channel (e.g., security email, issue tracker link, response SLA) instead of the generic instructions.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The SECURITY.md still contains placeholder template text (e.g., “Use this section to tell people...”)—replace these with concrete project-specific guidance on supported versions and security update policy.
- The reporting section should be updated with an actual vulnerability reporting channel (e.g., security email, issue tracker link, response SLA) instead of the generic instructions.

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.

@parkcheolhong parkcheolhong merged commit 6ab62f1 into main Apr 15, 2026
1 check passed
@parkcheolhong parkcheolhong deleted the parkcheolhong-patch-1 branch April 15, 2026 03:16
Copy link
Copy Markdown
Owner Author

@parkcheolhong parkcheolhong left a comment

Choose a reason for hiding this comment

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

변경 감사합니다.

Copy link
Copy Markdown
Owner Author

@parkcheolhong parkcheolhong left a comment

Choose a reason for hiding this comment

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

감사합니다

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