Add SECURITY.md file with security policy and bug bounty details

[dylanpulver]

Summary

This PR adds a SECURITY.md file to the repository, outlining our security policy, supported versions, and procedures for reporting vulnerabilities.

Details

• Added a new SECURITY.md file to the root of the repository.
• Included information on how to report a security vulnerability.
• Provided details about our bug bounty program, with a link to Bug Bounty Program.
• Listed supported versions of the software.
• Suggested security best practices for users.

Additional Information

All participants in our community, including those involved in security reports, are expected to adhere to our Code of Conduct.

Summary by CodeRabbit

• New Features
  • Introduced a SECURITY.md file outlining the security policy, including supported versions and a process for reporting vulnerabilities.
  • Established a bug bounty program for qualifying vulnerabilities and emphasized security best practices for users.

[coderabbitai]

Walkthrough

A new SECURITY.md file has been added to the project, detailing the security policy. It specifies supported software versions, outlines the process for reporting vulnerabilities, and describes a bug bounty program. The document also emphasizes security best practices for users and includes a reminder about adherence to the project's Code of Conduct.

Changes

Files	Change Summary
SECURITY.md	Added a new file outlining the security policy, supported versions, vulnerability reporting process, bug bounty program, security best practices, and Code of Conduct adherence.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Development Team
    participant Security Bounty Program

    User->>Development Team: Report vulnerability via email
    Development Team->>User: Acknowledge receipt
    User->>Security Bounty Program: Submit qualifying vulnerability
    Security Bounty Program->>User: Provide reward details

Loading

Poem

🐇 In the meadow of code, we hop with glee,
A new guide for safety, as bright as can be.
With bugs to report and bounties to claim,
We build a secure world, together in the game!
So keep your software updated, don’t let it decay,
For a safer tomorrow, let’s hop on our way! 🌼

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6664d76 and 0e3326d.

Files selected for processing (1)

• SECURITY.md (1 hunks)

Additional comments not posted (5)

SECURITY.md (5)

1-1: LGTM!

The section title "Security Policy" is appropriate and clear.

The code changes are approved.

---

3-10: LGTM!

The section "Supported Versions" is clear and informative. The table format is appropriate for displaying the supported versions.

The code changes are approved.

---

12-20: LGTM!

The section "Reporting a Vulnerability" is clear and provides essential information. The inclusion of an email address and a link to the bug bounty program is helpful.

The code changes are approved.

---

22-28: LGTM!

The section "Security Best Practices" is clear and provides valuable information for users.

The code changes are approved.

---

30-32: LGTM!

The section "Code of Conduct" is clear and provides a necessary reminder. The inclusion of a link to the Code of Conduct is helpful.

The code changes are approved.