Create SECURITY.md

[Dargon789]

Summary by Sourcery

Add a security policy document outlining supported versions and vulnerability reporting procedures.

Documentation:

• Add SECURITY.md with a table of supported project versions for security updates
• Add guidelines for reporting vulnerabilities including response expectations

[sourcery-ai]

Reviewer's Guide

Introduces a new SECURITY.md document defining the project’s security policy, including supported version matrix and vulnerability reporting guidance.

Entity relationship diagram for supported version matrix (from SECURITY.md)

erDiagram
    PROJECT ||--o{ VERSION : supports
    VERSION {
      string version
      boolean isSupported
    }

Loading

Flow diagram for vulnerability reporting process (from SECURITY.md)

flowchart TD
    A["User discovers vulnerability"] --> B["User reads SECURITY.md for reporting instructions"]
    B --> C["User submits vulnerability report"]
    C --> D["Project team reviews report"]
    D --> E["Team provides update to user"]
    E --> F["Vulnerability accepted or declined"]

Loading

File-Level Changes

Change	Details	Files
Add SECURITY.md with security policy sections	Created Security Policy header Added Supported Versions table Added Reporting a Vulnerability instructions	SECURITY.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[gemini-code-assist]

Summary of Changes

Hello @Dargon789, I'm Gemini Code Assist¹! 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 SECURITY.md file to the repository, a standard practice for open-source projects to communicate their security policies. This file serves to inform users about which versions of the project are actively supported with security updates and provides clear instructions on the process for reporting security vulnerabilities. This addition enhances the project's transparency regarding security and establishes a formal channel for vulnerability disclosure.

Highlights

• New Security Policy File: A new file named SECURITY.md has been added to the repository. This file is essential for outlining the project's security guidelines.
• Supported Versions Section: The SECURITY.md file includes a dedicated section for 'Supported Versions', providing a template table to clearly indicate which project versions receive security updates.
• Vulnerability Reporting Guidelines: A 'Reporting a Vulnerability' section has been included, offering guidance on how users can responsibly disclose security issues to the project maintainers.

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. ↩

[sourcery-ai]

Hey there - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[gemini-code-assist]

Code Review

This pull request adds a SECURITY.md file, which is a positive step for the project. However, the file appears to be a template filled with placeholder text and example data rather than project-specific information. My review highlights the critical need to replace this placeholder content with accurate details about supported versions and the vulnerability reporting process to make this security policy useful and effective.