Skip to content

docs(contributing): point vulnerability reports at the organization's security policy - #59

Merged
fylorn merged 1 commit into
devfrom
docs/contributing-security-policy
Sep 25, 2026
Merged

fylorn merged 1 commit into
devfrom
docs/contributing-security-policy

Conversation

@fylorn

@fylorn fylorn commented Sep 24, 2026

Copy link
Copy Markdown
Contributor

What this changes

The last paragraph of CONTRIBUTING.md's "Security-relevant changes" section now links the organization's security policy (SECURITY.md in 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

  • This repository has no SECURITY.md of its own, so the relative link was dead, and "contact the maintainer directly" gave no address to write to.
  • docs: default issue forms and a security policy for the organization .github#8 adds an organization-wide 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

  • Only this repository mentioned a security contact: git grep on dev finds no other reference to SECURITY.md or to contacting a maintainer, and the Lite and Core CONTRIBUTING.md files have no such paragraph.
  • The link target does not exist yet: https://github.com/ThinkWatchProject/.github/blob/main/SECURITY.md returns 404 until docs: default issue forms and a security policy for the organization .github#8 is merged, and https://github.com/ThinkWatchProject/ThinkWatch/security/policy shows "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

🤖 Generated with Claude Code

… 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>
@fylorn
fylorn merged commit ef3de87 into dev Sep 25, 2026
6 checks passed
@fylorn
fylorn deleted the docs/contributing-security-policy branch September 25, 2026 01:47
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.

1 participant