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

Add a security policy #179

Closed
pnacht opened this issue Apr 14, 2023 · 0 comments · Fixed by #178
Closed

Add a security policy #179

pnacht opened this issue Apr 14, 2023 · 0 comments · Fixed by #178
Assignees

Comments

@pnacht
Copy link
Contributor

pnacht commented Apr 14, 2023

Hey, it's Pedro and I'm back (see #177) with another security suggestion!

A security policy (SECURITY.md) is a simple document that explains how the project wishes to receive and handle responsible disclosure of potential vulnerabilities. GitHub recommends that projects have one.

The security policy can be found by users who enter the project's "Security" panel. Having a policy file also adds a reference to it in the "New issue" page.

There are two main ways to receive such disclosures:

If you want to use GitHub's reporting system, it must be activated for the repository:

  1. Open the repo's settings
  2. Click on Code security & analysis
  3. Click "Enable" for "Private vulnerability reporting (Beta)"

I'll send a PR with a draft policy along with this issue. You could also create a https://github.com/go-logr/.github repository and add the policy there, in which case the policy will be available in all of the org's projects.

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

Successfully merging a pull request may close this issue.

3 participants