-
Notifications
You must be signed in to change notification settings - Fork 11.8k
Create SECURITY.md #1037
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Create SECURITY.md #1037
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hello @shbaismail, 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!
Summary of Changes
Hello team, Gemini here! I've taken a look at this pull request by @shbaismail. The primary goal of this PR, based on the title and the changes introduced, is to add a standard SECURITY.md
file to the repository. This file serves as a crucial piece of documentation, guiding users and potential contributors on how to responsibly report security vulnerabilities they might discover and outlining which versions of the project are currently receiving security support.
Highlights
- Add Security Policy: This pull request introduces a new file,
SECURITY.md
, which contains a template for the project's security policy. This policy is essential for communicating how security vulnerabilities should be reported and which project versions are actively supported with security updates.
Changelog
- SECURITY.md
- Initial creation of the
SECURITY.md
file. - Added standard sections for 'Supported Versions' and 'Reporting a Vulnerability'.
- Included a placeholder table for listing supported versions.
- Initial creation of the
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
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 issue 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 is currently in preview and 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 to provide feedback.
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.
Security doc new,
Tell us how to report bugs,
Keep the code safe now.
Footnotes
-
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. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
Thank you for adding a SECURITY.md
file. This is an important step for communicating security policies to users and contributors. However, the current content appears to be the default template provided by GitHub and needs to be customized with information specific to this project. I've added a couple of comments to highlight the sections that require your attention.
Summary of Findings
- Incomplete 'Supported Versions' Information: The 'Supported Versions' section in SECURITY.md uses placeholder data and needs to be updated with actual project version support details.
- Incomplete 'Reporting a Vulnerability' Instructions: The 'Reporting a Vulnerability' section in SECURITY.md is a template and requires specific instructions on how to report vulnerabilities for this project.
Merge Readiness
The addition of a SECURITY.md
file is a good initiative. However, the current version consists of placeholder template content. To make this file useful, the 'Supported Versions' and 'Reporting a Vulnerability' sections need to be filled out with information specific to the 'Android Architecture Samples' project. Due to these high-severity issues, I recommend that these changes be addressed before merging. I am not authorized to approve pull requests, so please ensure further review and approval as per your team's process once the requested changes are made.
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: | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This 'Supported Versions' section currently contains placeholder data. Could you please update this table with the actual versions of the 'Android Architecture Samples' project that are actively supported with security updates? If this project follows a different support model (e.g., only the latest version on the main branch is supported), please clarify that here.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The 'Reporting a Vulnerability' section is also a template. To make this actionable, could you please provide specific instructions on how users should report security vulnerabilities for this project? This typically includes:
- Preferred contact methods (e.g., a dedicated email address, private bug tracker, or instructions for creating a confidential issue on GitHub if supported).
- Information on what details to include in the report.
- Expected response timelines or SLAs, if any.
- What to expect regarding the disclosure process.
for my @[email protected]
@Qsxtl189