Flesh out CONTRIBUTING.md and SECURITY.md#663
Open
JobDoesburg wants to merge 2 commits into
Open
Conversation
CONTRIBUTING.md: - New "Quick start" with a concrete checklist (set up locally, branch, make the change, run the actual lint/test/schema-validate commands, open the PR). Replaces the bare 3-bullet workflow at the bottom. - New "Opening a pull request" section spelling out what makes a good PR (one concern, descriptive body, tests for fixes, migration in the same commit, don't squash someone else's commits, don't force-push or --no-verify past hooks). - New "Reviewer checklist" — what a reviewer is expected to check before approving. Makes the implicit explicit and gives the reviewer-and-contributor pair a shared bar to look at. - Pointer to AGENTS.md at the top — same conventions, condensed for AI coding tools. Was easy to miss before. - Pointer to SECURITY.md from the sensitive-apps section so the reader has the right disclosure path in mind. - Other content (scope check, modular apps, services, migrations, fixtures, performance, time zones, CSP, sensitive apps, privacy, testing, code style) kept verbatim — it was accurate. - Added pydocstyle to the listed code-style tools; CI already runs it but the doc didn't say so. - Heading hierarchy and language touch-ups for consistency. SECURITY.md: - Promoted from a 9-line stub to a real disclosure policy. - New "Supported versions" section that names the production deployment (tosti.science.ru.nl) and the TOSTI-fridge-client repo as the supported surfaces. - New "Reporting a vulnerability" section: don't open a public issue; email www-tosti@science.ru.nl; what to include in the report; expect an acknowledgement within 7 days; escalation path at 14 days. - New "What counts as a security issue" with explicit in/out-of-scope lists. Calls out the load-bearing surfaces: auth/scope bypasses, age verification (legally loaded), OAuth/MCP, SAML, privacy leaks, injection classes, secret leakage, supply chain. Out-of-scope: non-security bugs, cosmetic issues, third-party domains, unverified scanner output. - New "What we ask of reporters" — don't pivot, don't test in production unnecessarily, coordinate disclosure timelines. No code, no behaviour change. Pure documentation. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There's only one inbox in practice. Stop referring to it under two names (``tartaruswebsite@`` was the older alias) so a reader looking for the right address doesn't have to wonder which to pick. - CONTRIBUTING.md: header reachable-at line and "Getting help" bottom both point at www-tosti@. - SECURITY.md: the maintainer-contact section drops the general-vs-security split (same inbox); the escalation paragraph no longer points at the dead-letter alias.
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 does
Brings the two root-level community docs up to the same standard as the rest of the repo.
CONTRIBUTING.md
The existing version was actually pretty good (modular-apps rule, services pattern, migrations, fixtures, time zones, CSP, sensitive apps, privacy, testing, code style — all already there and accurate). The weakness was the bottom: a 3-bullet workflow that didn't tell a new contributor what their first PR should actually look like.
Additions:
--no-verifypast hooks.Existing content kept verbatim.
SECURITY.md
Promoted from a 9-line stub to a real disclosure policy.
Test plan
> [!IMPORTANT]callout in CONTRIBUTING.md display correctly.AGENTS.md,SECURITY.md,deploy/README.md,README.mdanchors).