Skip to content
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

Create SECURITY.md #276

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Create SECURITY.md #276

wants to merge 1 commit into from

Conversation

chong1218
Copy link

No description provided.

Copy link

@DISTinTheHouse DISTinTheHouse left a comment

Choose a reason for hiding this comment

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

### I've reviewed the "securite.md" file and would like to suggest the following improvements:

File Naming:
Consider renaming the file to "security.md" if the current name is a typo.

Supported Versions Section:

While the table is clear, it would be beneficial to include a short explanation of the criteria for determining version support.
Add a note on what types of security updates (e.g., critical patches vs. minor updates) users should expect.
Reporting a Vulnerability Section:

The current text is too generic. We should add specific instructions for reporting vulnerabilities, such as providing an email address (e.g., security@example.com) or a direct link to a submission form.
Include details about the process, such as expected response times, steps that will be followed after a report is submitted, and how confidentiality is maintained.
It might also be helpful to link to a detailed disclosure policy or additional guidelines.
Overall Structure and Clarity:

Consider adding a brief introduction that highlights the importance of the security policy.
Using bullet points for the steps or procedures in the reporting process could improve readability.
These changes should make our security policy more informative and user-friendly. Let me know what you think.

Thanks!

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.

2 participants