docs(contributing): point vulnerability reports at the organization's security policy - #59
Merged
Merged
Conversation
… security policy The paragraph sent reporters to a SECURITY.md this repository does not have, or to "the maintainer directly" with no address to write to. The organization-wide policy in ThinkWatchProject/.github applies to this repository and says how to reach the maintainers privately. That policy asks for one public issue: a "Security contact request" with an empty body, used while private vulnerability reporting is off. "Don't open a public issue" would contradict it, so the sentence now rules out describing the vulnerability in public, as the policy does. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
What this changes
The last paragraph of CONTRIBUTING.md's "Security-relevant changes" section now links the organization's security policy (
SECURITY.mdin ThinkWatchProject/.github) instead of "SECURITY.md if present, or contact the maintainer directly", and it asks contributors not to describe a vulnerability in a public issue, PR, commit or comment.Why
SECURITY.mdof its own, so the relative link was dead, and "contact the maintainer directly" gave no address to write to.SECURITY.md, which GitHub applies to every repository in the organization without its own. While private vulnerability reporting is off, that policy asks for one public issue: a "Security contact request" with an empty body, answered with a draft security advisory. "Don't open a public issue" would contradict it; "don't describe a vulnerability in public" matches its wording.How it was verified
git grepondevfinds no other reference to SECURITY.md or to contacting a maintainer, and the Lite and Core CONTRIBUTING.md files have no such paragraph.https://github.com/ThinkWatchProject/.github/blob/main/SECURITY.mdreturns 404 until docs: default issue forms and a security policy for the organization .github#8 is merged, andhttps://github.com/ThinkWatchProject/ThinkWatch/security/policyshows "No security policy detected" today. The link names the file in the .github repository rather than this repository's Security › Policy page because the page can only be checked once the organization default is live.Notes for review
https://github.com/ThinkWatchProject/ThinkWatch/security/policyshows the organization policy, the link could point there instead; either reaches the same file.🤖 Generated with Claude Code