Skip to content

Conversation

@CJN-16125
Copy link

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

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

Summary of Changes

Hello @CJN-16125, 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 new SECURITY.md file to the repository, which serves as a comprehensive security policy document. Its primary purpose is to clearly communicate the project's stance on security, detailing which versions are actively maintained with security updates and providing a structured process for users to report potential vulnerabilities. This addition aims to improve transparency and streamline security-related communications for the project.

Highlights

  • New Security Policy Document: A SECURITY.md file has been added to the repository, establishing a formal security policy for the project.
  • Supported Versions Outlined: The new policy clearly specifies which project versions are currently supported with security updates, presented in an easy-to-read table format.
  • Vulnerability Reporting Guidelines: Instructions on how to report vulnerabilities are now provided, guiding users through the process and setting expectations for response and resolution.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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 adds a SECURITY.md file, which is a great step for the project's security posture. However, the current file consists mainly of placeholder text from the default GitHub template. I've left specific comments on the sections that need to be updated with your project's actual security policy, including supported versions and the vulnerability reporting process. Filling these out is crucial for the document to be effective.

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.

high

This section contains placeholder text for reporting vulnerabilities. It's crucial to replace this with a clear and specific process. You should detail how to report a vulnerability (e.g., via email to a specific address, or using GitHub's private vulnerability reporting feature), expected response times, and what the reporter can expect from the 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.
We take all security bugs in this project seriously. If you believe you have found a security vulnerability, please report it to us through one of the following channels:
- **Email**: Send an email to `[email protected]`.
- **GitHub Private Vulnerability Reporting**: Use the [private vulnerability reporting feature](https://github.com/FirebaseExtended/firebase-framework-tools/security/advisories/new) on this repository.
You can expect a response from us within 48 hours. If the issue is confirmed, we will release a patch as soon as possible depending on complexity.

Comment on lines +5 to +6
Use this section to tell people about which versions of your project are
currently being supported with security updates.

Choose a reason for hiding this comment

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

medium

This section contains placeholder text from the default GitHub security policy template. Please remove this instructional text, as the section header and table are self-explanatory.

Comment on lines +10 to +13
| 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.

medium

The versions listed in the support table appear to be examples. Please update this table with the actual versions of your project and their current security 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