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 #5

Open
github-learning-lab bot opened this issue Oct 6, 2021 · 0 comments
Open

Add a Security Policy #5

github-learning-lab bot opened this issue Oct 6, 2021 · 0 comments

Comments

@github-learning-lab
Copy link

Adding a security policy

Just like most repositories have a README.md file to provide instructions on how to contribute to the repository, a SECURITY.md file highlights security related information and instructions on how to handle security related issues and best practices.

This gives collaborators the important security information they need, but it also documents a place where maintainers can think about how they should deal with security disclosures, updates, and general security practices within this repository.

What should I include in my security policy?

Just like a README.md file, it really depends on your repository and the requirements and workflows. Here are a few common topics that are documented in a security policy:

  • Supported versions
  • How to responsibly report a security vulnerability
  • Security related configuration
  • Known security gaps and future enhancements

Step 6: Add a SECURITY.md file

  1. Navigate to the Security tab
  2. Click on Security Policy located in the left sidebar
  3. Click the Start Setup button
  4. Commit the template security policy to the new branch as selected Puneet-Minhas-patch-1
  5. Commit the new file and create the pull request

Alternatively, you could also create a new file in the root directory called SECURITY.md, write up a quick security policy, and open a pull request.


I'll respond in your pull request with next steps.

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

No branches or pull requests

0 participants