Docs: add SECURITY.rst - #14644
Draft
aryansk wants to merge 1 commit into
Draft
Conversation
Adds SECURITY.rst documenting the security policy for Sphinx: report via GitHub Security Advisories (preferred) or email as per CONTRIBUTING.rst, supported versions, and disclosure policy. Fixes sphinx-doc#13063 Co-authored-by: Muse Spark <muse-spark@users.noreply.github.com> Co-authored-by: Aryan Singh K <70511529+aryansk@users.noreply.github.com> AI disclosure: Muse Spark assisted in drafting the policy; changes reviewed and tested manually.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Following recent discussion, we should better publicise our security policy (which is currently to use GitHub's Security Advisories or to email the maintainer).
There is no
SECURITY.rst(orSECURITY.md) in the repository, so contributors have no clear place to find the policy.Fixes #13063
Change
Adds
SECURITY.rstat the repository root:GitHub Security Advisories <https://github.com/sphinx-doc/sphinx/security/advisories/new>_ (preferred) or email as perCONTRIBUTING.rstSingle-file docs-only addition.
Why this approach
SECURITY.rstis the conventional location GitHub surfaces via the Security tab (“View security policy”). Using reStructuredText matches the rest of the repo (README.rst,CONTRIBUTING.rst, etc.) and keeps the policy discoverable both on GitHub and in the docs.Testing
Documentation and release impact
Review notes
AI disclosure
Muse Spark assisted in drafting the policy; all changes reviewed and tested manually. Co-authored-by trailers included for Pair Extraordinaire.
Co-authored-by: Muse Spark muse-spark@users.noreply.github.com
Co-authored-by: Aryan Singh K 70511529+aryansk@users.noreply.github.com