-
Notifications
You must be signed in to change notification settings - Fork 3
doc: add SECURITY.md #3
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
Conversation
Summary of ChangesHello @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 introduces a new Highlights
Using Gemini Code AssistThe 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
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 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
|
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
This pull request adds a SECURITY.md
file, which is a great addition for outlining the project's security policy. The document is well-structured and clear. I've made a few suggestions to improve consistency with the rest of the project's documentation and to clean up some minor formatting issues.
We're extremely grateful for security researchers and users who report vulnerabilities they discovered in modelpack. | ||
All reports are thoroughly reviewed and investigated. | ||
|
||
### When Should I Report a Vulnerability? | ||
|
||
You should report if: | ||
|
||
- You think you have discovered a potential security vulnerability in modepack | ||
- You are uncertain about the security impact of an issue you found in modelpack |
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.
For consistency with other project documentation (e.g., GOVERNANCE.md
), 'ModelPack' should be consistently capitalized. There are a few instances in this section where it's either lowercase or misspelled.
- Line 5:
modelpack
->ModelPack
- Line 12:
modepack
->ModelPack
- Line 13:
modelpack
->ModelPack
We're extremely grateful for security researchers and users who report vulnerabilities they discovered in modelpack. | |
All reports are thoroughly reviewed and investigated. | |
### When Should I Report a Vulnerability? | |
You should report if: | |
- You think you have discovered a potential security vulnerability in modepack | |
- You are uncertain about the security impact of an issue you found in modelpack | |
We're extremely grateful for security researchers and users who report vulnerabilities they discovered in ModelPack. | |
All reports are thoroughly reviewed and investigated. | |
### When Should I Report a Vulnerability? | |
You should report if: | |
- You think you have discovered a potential security vulnerability in ModelPack | |
- You are uncertain about the security impact of an issue you found in ModelPack |
SECURITY.md
Outdated
|
||
### Public Disclosure Timing | ||
|
||
The disclosure date will be agreed upon between the modelpack maintainers and the reporter. |
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.
For consistency, modelpack
should be capitalized as ModelPack
. Additionally, the two trailing spaces at the end of this line are unnecessary for formatting here and can be removed for cleaner source code.
The disclosure date will be agreed upon between the modelpack maintainers and the reporter. | |
The disclosure date will be agreed upon between the ModelPack maintainers and the reporter. |
SECURITY.md
Outdated
- Immediate disclosure may occur if the issue is already public. | ||
- For vulnerabilities with straightforward fixes, disclosure is typically within **7 days** of the report. | ||
- For complex issues requiring more time to investigate and validate fixes, disclosure may be delayed—up to a maximum of **90 days**. |
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.
These lines have unnecessary trailing spaces. In Markdown, two trailing spaces can create a hard line break, but here they have no visual effect within the list. Removing them leads to cleaner source text.
- Immediate disclosure may occur if the issue is already public. | |
- For vulnerabilities with straightforward fixes, disclosure is typically within **7 days** of the report. | |
- For complex issues requiring more time to investigate and validate fixes, disclosure may be delayed—up to a maximum of **90 days**. | |
- Immediate disclosure may occur if the issue is already public. | |
- For vulnerabilities with straightforward fixes, disclosure is typically within **7 days** of the report. | |
- For complex issues requiring more time to investigate and validate fixes, disclosure may be delayed—up to a maximum of **90 days**. |
DCO is failing. Please sign off your commit. |
fb35f70
to
4840064
Compare
@bergwolf PTAL. ❤️ (sry for the delay. I've been very busy these days. 😂 |
11a32ab
to
408532a
Compare
Signed-off-by: caozhuozi <[email protected]>
408532a
to
9edf9d6
Compare
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.
lgtm, thanks!
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.
LGTM
No description provided.