Skip to content

Conversation

@jz197781
Copy link

@jz197781 jz197781 commented Dec 2, 2025

Add a security policy document outlining supported versions and vulnerability reporting.

Add a security policy document outlining supported versions and vulnerability reporting.
@gemini-code-assist
Copy link

Summary of Changes

Hello @jz197781, 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 introduces a foundational SECURITY.md file to the project. Its primary purpose is to enhance transparency and provide clear guidelines regarding the project's security posture. This includes informing users about the lifecycle of security support for different project versions and establishing a standardized procedure for reporting potential vulnerabilities, thereby contributing to a more secure and well-managed codebase.

Highlights

  • New Security Policy Document: A new file, SECURITY.md, has been added to the repository to establish a clear security policy.
  • Supported Versions: The SECURITY.md file includes a section detailing which versions of the project are currently supported with security updates, presented in a table format.
  • Vulnerability Reporting Guidelines: The new security document outlines a process for reporting vulnerabilities, providing guidance on where to go and what to expect after reporting.
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

@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 introduces a SECURITY.md file, which is an important step for the project's security posture. However, the file currently contains placeholder content from a template. My review focuses on the need to replace this placeholder text with the project's actual security policy. Specifically, the 'Supported Versions' section needs to be clarified, and the 'Reporting a Vulnerability' section requires concrete instructions for reporters. Addressing these points is critical to ensure the security policy is clear and actionable.

Comment on lines +17 to +21
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.

Choose a reason for hiding this comment

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

critical

The 'Reporting a Vulnerability' section contains only placeholder text. It is critical to provide clear, actionable instructions for anyone who finds a security vulnerability. Please replace this placeholder with specific details, including the exact reporting channel (e.g., a dedicated email address or GitHub's private vulnerability reporting feature) and what reporters can expect regarding response times and the handling process.

Suggested change
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.
To report a security vulnerability, please use the **Private Vulnerability Reporting** feature on GitHub.
You can expect a response from our team within 48 hours of submission. If the vulnerability is accepted, we will work on a fix and disclose it publicly after the patch is released.

Comment on lines +5 to +13
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: |

Choose a reason for hiding this comment

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

high

The content in the 'Supported Versions' section appears to be the default template text and presents a confusing support schedule (e.g., version 5.0.x is unsupported while the older 4.0.x is supported). Please replace this placeholder with the project's actual version support policy. For clarity, it's best to list versions in descending order and accurately state their support status.

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