doc: add SECURITY.md #122
doc: add SECURITY.md #122
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @caozhuozi, 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 repository by adding a SECURITY.md file. This new document provides clear instructions for users on how to responsibly report potential security vulnerabilities, leveraging GitHub's built-in security features, and advises against public disclosure to ensure issues can be addressed privately. This is a foundational step to enhance the project's security posture.
Highlights
- New Security Policy Document: Introduces SECURITY.md to outline the process for reporting security vulnerabilities.
- Vulnerability Reporting Process: Details how to report vulnerabilities using GitHub's Security Advisories feature, ensuring private disclosure to maintainers.
- Responsible Disclosure Guidance: Emphasizes the importance of not publicly discussing vulnerabilities via issues, PRs, or discussions to prevent exploitation.
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 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
-
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.
Code Review
The pull request adds a SECURITY.md file to the repository, outlining the process for reporting security vulnerabilities. The file instructs users to use the GitHub Security Advisories feature and avoid public discussions to prevent premature exploitation. The review focuses on ensuring the clarity and effectiveness of the instructions provided in the new file.
SECURITY.md
Outdated
| This repository is set up to allow vulnerability reports through GitHub's Security Advisories feature. To report a vulnerability: | ||
|
|
||
| 1. Navigate to the repository's main page. | ||
| 2. Select the [**Security**](https://github.com/modelpack/model-spec/security) tab. |
There was a problem hiding this comment.
The link to the security tab should be a relative link to avoid hardcoding the repository name. This will ensure the link remains valid even if the repository is renamed or moved. Consider using a relative link like [**Security**](./security).
| 2. Select the [**Security**](https://github.com/modelpack/model-spec/security) tab. | |
| 2. Select the [**Security**](./security) tab. |
caozhuozi
force-pushed
the
add-security-md
branch
2 times, most recently
from
82fb1d4 to
0b80d01
Compare
|
The doc doesn't mention how a security issue will be handled by the maintainers. Is it a common practice for CNCF project's SECURITY.md? |
Signed-off-by: caozhuozi <[email protected]>
Signed-off-by: caozhuozi <[email protected]>
|
I think it would be worth clarifying which versions will be patched for vulnerabilities. I don't think we want to imply a responsibility to patch versions that could be 20-30 behind latest do we? Perhaps we can limit it to only |
Thats a good point! |
Signed-off-by: caozhuozi <[email protected]>
caozhuozi
force-pushed
the
add-security-md
branch
from
697cfae to
5ddf491
Compare
|
@bmicklea added supported versions. |
|
Could you add |
|
sure |
|
@bergwolf updated. PTAL. |
Signed-off-by: caozhuozi <[email protected]>
caozhuozi
force-pushed
the
add-security-md
branch
from
203bdb2 to
a75ebf8
Compare
|
Depending on modelpack/community#3 |
5 participants
Description
part of the ONBOARDNG task.
Related Issue
Motivation and Context