Skip to content

Create SECURITY.md#1

Merged
Dargon789 merged 2 commits intocanaryfrom
Dargon789-patch-1
Jan 17, 2026
Merged

Create SECURITY.md#1
Dargon789 merged 2 commits intocanaryfrom
Dargon789-patch-1

Conversation

@Dargon789
Copy link
Owner

@Dargon789 Dargon789 commented Jan 17, 2026

Summary by Sourcery

Documentation:

  • Introduce SECURITY.md with information on supported versions and placeholders for vulnerability reporting procedures.

Signed-off-by: Dargon789 <64915515+Dargon789@users.noreply.github.com>
@sourcery-ai
Copy link

sourcery-ai bot commented Jan 17, 2026

Reviewer's Guide

Adds a new SECURITY.md file outlining the project’s security policy template, including supported versions and guidelines for reporting vulnerabilities.

File-Level Changes

Change Details Files
Introduce a SECURITY.md document defining security policy structure and placeholders.
  • Create a new SECURITY.md file at the repository root
  • Document a sample supported versions matrix using markdown table formatting and status icons
  • Add placeholder guidance text for how to report vulnerabilities and what reporters can 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

@gemini-code-assist
Copy link

Summary of Changes

Hello @Dargon789, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request establishes a formal security policy for the project by adding a SECURITY.md file. This document is crucial for informing users about which project versions receive security support and provides clear instructions on how to report potential vulnerabilities, thereby enhancing the project's security posture and transparency.

Highlights

  • New Security Policy Document: Introduced a SECURITY.md file to outline the project's security policy, including supported versions and guidelines for reporting vulnerabilities.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@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 found 1 issue, and left some high level feedback:

  • The SECURITY.md content still uses template placeholder text (e.g., "Use this section to tell people..."); consider replacing these with concrete instructions specific to this project’s security process and communication channels.
  • The supported versions table lists specific versions (5.1.x, 5.0.x, 4.0.x, etc.) that don’t appear to match this repository’s actual release scheme; aligning this table with real maintained versions and how they’re determined would make the policy actionable.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The SECURITY.md content still uses template placeholder text (e.g., "Use this section to tell people..."); consider replacing these with concrete instructions specific to this project’s security process and communication channels.
- The supported versions table lists specific versions (5.1.x, 5.0.x, 4.0.x, etc.) that don’t appear to match this repository’s actual release scheme; aligning this table with real maintained versions and how they’re determined would make the policy actionable.

## Individual Comments

### Comment 1
<location> `SECURITY.md:5-14` </location>
<code_context>
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 5.1.x   | :white_check_mark: |
+| 5.0.x   | :x:                |
+| 4.0.x   | :white_check_mark: |
+| < 4.0   | :x:                |
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.
</code_context>

<issue_to_address>
**🚨 suggestion (security):** Replace template placeholder text with concrete project-specific security policy details

This still contains the default template text (e.g., “Use this section to tell people…”). For a published SECURITY.md, please replace these instructions with your actual supported-version policy and a specific vulnerability reporting process (contact methods, response expectations, triage flow, etc.).

Suggested implementation:

```
## Supported Versions

The following table lists which versions of this project currently receive
security updates. Only actively supported versions will receive fixes for
security vulnerabilities.

| Version | Supported          | Notes                                   |
| ------- | ------------------ | ----------------------------------------|
| 5.1.x   | :white_check_mark: | Active development and security fixes   |
| 5.0.x   | :x:                | No longer supported                     |
| 4.0.x   | :white_check_mark: | Security fixes only (no new features)   |
| < 4.0   | :x:                | End of life                             |

We strongly recommend running the latest supported minor version to ensure you
receive timely security updates.

```

```
## Reporting a Vulnerability

If you believe you have found a security vulnerability in this project, please
contact the maintainers directly and do **not** open a public issue.

### How to report

- Email: security@project.org  
- Subject line: `SECURITY: <short description>`
- Please include:
  - A detailed description of the issue
  - Steps to reproduce (proof-of-concept if possible)
  - The affected version(s)
  - Any relevant logs, configuration snippets, or screenshots

### Our process

1. **Acknowledgement**  
   We will acknowledge receipt of your report within **3 business days**.

2. **Triage and assessment**  
   We will investigate the issue, determine its impact, and assign a severity.
   We may contact you for additional information during this phase.

3. **Remediation**  
   - We will work on a fix and prepare a new release for supported versions.
   - For high and critical severity issues, we aim to release a fix within
     **14 days** of confirmation, where feasible.

4. **Disclosure**  
   - Once a fix is available, we will publish release notes describing the
     issue and the remediation steps.
   - We will credit you as the reporter in the release notes, if you wish.

Please make a good-faith effort to avoid privacy violations, data destruction,
or service disruption while testing, and do not publicly disclose details of
the vulnerability until we have released a fix.

```
</issue_to_address>

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

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds a SECURITY.md file, which is a great step for improving project security. However, the file currently contains placeholder content from a generic template. I've left specific comments on how to populate the 'Supported Versions' and 'Reporting a Vulnerability' sections with information specific to Next.js. Filling out this policy is crucial to provide clear guidance to users and security researchers.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Dargon789 <64915515+Dargon789@users.noreply.github.com>
Copy link
Owner Author

@Dargon789 Dargon789 left a comment

Choose a reason for hiding this comment

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

Create SECURITY.md#1

@Dargon789 Dargon789 merged commit cc8a3d3 into canary Jan 17, 2026
13 of 27 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