Skip to content

Add a security policy #179

Closed
Closed
@pnacht

Description

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.

Activity

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

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions