Skip to content

Doc badge rate limits, security.txt, badge locales - #3129

Merged
david-a-wheeler merged 1 commit into
mainfrom
document-badge-limits-security-txt
Nov 13, 2026
Merged

david-a-wheeler merged 1 commit into
mainfrom
document-badge-limits-security-txt

Conversation

@david-a-wheeler

Copy link
Copy Markdown
Collaborator

Recent changes weren't reflected in our documentation; this commit fixes that:

  • The assurance case's rate-limit list omitted nonbadge_req/ip, so nothing explained that badge images of every series (now including /projects/N/baseline) get the faster limit.
  • No document mentioned /.well-known/security.txt. We now explain that it follows RFC 9116, points to SECURITY.md, and has a computed Expires field. The Expires field is required by the RFC, so having a computed field seemed like the best solution.
  • The assurance case sent vulnerability reporters through CONTRIBUTING.md instead of straight to SECURITY.md.
  • docs/api.md said only /projects/NNN/badge skips locale redirection; /projects/NNN/baseline does too.

docs/case.md and docs/assurance-case.md both contain this text, so we make the same edits to both until we finish switching to Verocase.

Assisted-by: Claude:claude-opus-5-5

Recent changes weren't reflected in our documentation;
this commit fixes that:

* The assurance case's rate-limit list omitted nonbadge_req/ip, so
  nothing explained that badge images of every series (now including
  /projects/N/baseline) get the faster limit.
* No document mentioned /.well-known/security.txt. We now explain
  that it follows RFC 9116, points to SECURITY.md, and has a computed
  Expires field. The Expires field is *required* by the RFC, so
  having a computed field seemed like the best solution.
* The assurance case sent vulnerability reporters through
  CONTRIBUTING.md instead of straight to SECURITY.md.
* docs/api.md said only /projects/NNN/badge skips locale redirection;
  /projects/NNN/baseline does too.

docs/case.md and docs/assurance-case.md both contain this text, so
we make the same edits to both until we finish switching to Verocase.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: David A. Wheeler <dwheeler@dwheeler.com>
@codecov

codecov Bot commented Nov 13, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (63f64f7) to head (70fc241).

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #3129   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           89        89           
  Lines         4798      4798           
=========================================
  Hits          4798      4798           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@david-a-wheeler
david-a-wheeler merged commit b446c8a into main Nov 13, 2026
14 checks passed
@david-a-wheeler
david-a-wheeler deleted the document-badge-limits-security-txt branch November 13, 2026 18:10
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