mvdnes / spin-rs

Spin-based synchronization primitives
MIT License
485 stars 92 forks source link

Add a Security-Policy #155

Closed diogoteles08 closed 1 year ago

diogoteles08 commented 1 year ago

Hi! I'm Diogo and I'm back (see #140) hoping to offer a bit more help with security enhancements.

This time I'm here to suggest that you expose a way that users can report eventual vulnerabilities in a safe and efficient way. This is usually done through a Security Policy, which is a GitHub standard document (SECURITY.md) added on the root of the repo and that will be visible to the users in the "Security Tab", as you can see bellow:

image

Having a Security Policy is a recommendation from Github itself, and from Scorecard (being a security measure of medium priority).

Aiming to make this change easier, I'll take the liberty and submit a suggestion of a Security Policy as a PR. Please feel free to edit it directly or ask me for editions until it is in compliance with how mvdnes/spin-rs would best handle vulnerability reports.