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

Security Policy should be highlighted as a first-class document like LICENSE, INSTALL, CONTRIBUTING, Changes etc. #3246

Open
robrwo opened this issue Dec 6, 2024 · 0 comments

Comments

@robrwo
Copy link

robrwo commented Dec 6, 2024

Security policies are important documents, and the policy file named something like SECURITY or security.txt or SECURITY-POLICY.md should be highlighted when users view a release.

At the moment, it does not show the policy at all and the user needs to browse the release files to see it.

Note that a guide to including a security policy with distributions has been added to the CPAN Security Group (CPANSec) page at https://security.metacpan.org/docs/guides/security-policy-for-authors.html and GitHub also recommends adding a security policy to repositories now.

The rationale is to let users know how to report a security issue with the software, what will be supported, and what response they can expect.

Common names for it (case-insensitive) would match m/security(\.(txt|md|pod))?/in e.g.

  • SECURITY.md
  • security.txt
  • Security.pod
  • SECURITY

Note: as of 6 January there were at least 63 distributions with SECURITY.MD and this is starting to get traction, e.g. on Reddit here and there,

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant