diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..d36beed --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,46 @@ +# Security Policy + +## Supported Versions + +Use this section to tell people about which versions of your project are +currently being supported with security updates. + +| Version | Supported | +| ------- | ------------------ | +| 5.1.x | :white_check_mark: | +| 5.0.x | :x: | +| 4.0.x | :white_check_mark: | +| < 4.0 | :x: | + +## Access Control + +This section outlines the access control policies for contributing to the project. + +### Forking the Repository + +- Forking is allowed by default. +- Contributors are encouraged to fork the repository to make changes. + +### Creating Pull Requests + +- Contributors need to write access to the repository or can fork the repository and create a pull request from their fork. + +### Viewing Pull Requests + +- Viewing pull requests is allowed for anyone with access to the repository. + +## Reporting a Vulnerability + +Use this section to tell people how to report a vulnerability. + +Tell them where to go, how often they can expect to get an update on a +reported vulnerability, what to expect if the vulnerability is accepted or +declined, etc. + +Provide instructions for reporting vulnerabilities, such as a dedicated email address or a link to an issue tracker. + +For example: +- Report security vulnerabilities to security@example.com. +- We aim to respond within 48 hours. +- Vulnerabilities will be triaged, and further communication will be provided based on the severity. +