Skip to content

docs: add SECURITY.md with vulnerability reporting policy#14353

Open
sedat4ras wants to merge 1 commit intosphinx-doc:masterfrom
sedat4ras:docs/add-security-policy
Open

docs: add SECURITY.md with vulnerability reporting policy#14353
sedat4ras wants to merge 1 commit intosphinx-doc:masterfrom
sedat4ras:docs/add-security-policy

Conversation

@sedat4ras
Copy link
Copy Markdown

Purpose

Adds .github/SECURITY.md to publish Sphinx's security vulnerability reporting policy.

Closes #13063

GitHub automatically surfaces this file in the repository's Security tab and shows a "Report a vulnerability" button to users, replacing the generic GitHub message with project-specific guidance.

The policy documents:

  • GitHub Security Advisories as the preferred private reporting channel
  • Email contact as an alternative (admin@sphinx-doc.org — please update if this is incorrect)
  • Which versions receive security fixes (latest stable only)
  • The disclosure process outline

Note to maintainers: Please verify the email address is correct or update it to the preferred contact. The issue mentioned emailing the lead maintainer directly; if you'd prefer that, replace admin@sphinx-doc.org with the appropriate address.

References

Closes sphinx-doc#13063

Add a GitHub security policy file (.github/SECURITY.md) that documents
how to report vulnerabilities in Sphinx. Covers:
- GitHub Security Advisories as the preferred private channel
- Email contact as an alternative
- Supported versions policy
- Disclosure process outline

GitHub automatically surfaces this file in the Security tab and shows
a "Report a vulnerability" button to users.
@sedat4ras
Copy link
Copy Markdown
Author

Closing — CI failed on the job (unrelated to the change, but keeping the PR clean). Will reopen once the issue is investigated.

@sedat4ras sedat4ras closed this Mar 23, 2026
@sedat4ras sedat4ras reopened this Mar 23, 2026
@sedat4ras
Copy link
Copy Markdown
Author

Note on the CI failure: the ty job is failing, but this is unrelated to this PR — ty is a type checker linting the Sphinx Python source code, and SECURITY.md is a plain Markdown file that doesn't touch any Python code. The failure appears to be a pre-existing issue in the repository unrelated to this change.

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 this pull request may close these issues.

Add SECURITY.rst

1 participant