Release Notes for Responsible Disclosure Fixes
How to write release notes when fixing vulnerabilities reported through responsible disclosure. Covers coordinated disclosure timelines, credit, and embargo handling.
Security
Detailed Explanation
Responsible Disclosure in Release Notes
When a security researcher reports a vulnerability through responsible disclosure, the release notes for the fix need to balance transparency with responsible timing.
Coordinated Disclosure Timeline
Day 0 — Vulnerability reported privately
Day 1-3 — Acknowledge receipt, begin investigation
Day 7 — Confirm vulnerability, begin developing fix
Day 14 — Fix ready, tested across supported versions
Day 15 — Coordinate disclosure date with reporter
Day 21 — Release fix, publish advisory (CVE if applicable)
Day 28+ — Publish full technical details
Release Note Template
## [2.4.1] - 2026-02-28
### Security
- **HIGH (CVE-2026-XXXXX):** Fix authentication bypass in API key
validation. Requests with malformed API keys could bypass rate
limiting and access protected endpoints without valid
credentials. Affects v2.2.0 through v2.4.0.
**Severity:** CVSS 8.1 (High)
**Affected versions:** 2.2.0 - 2.4.0
**Fix:** Strict API key format validation before processing
**Credit:** Reported by Jane Smith (@janesmith) via our
security bug bounty program
See [Security Advisory SA-2026-001](link) for full details.
What to Include
- Severity and CVE — use CVSS scoring for consistency
- Affected versions — exact range
- Brief description — vulnerability type without exploit details
- Credit — always credit the reporter (with permission)
- Link to advisory — for users who need more details
What NOT to Include
- Proof-of-concept exploit code
- Exact payload that triggers the vulnerability
- Internal investigation details
- Names of affected customers
Multi-Version Backport
When the fix is backported to multiple release branches, document all fixed versions:
Fixed in: v2.4.1, v2.3.5, v2.2.8 (LTS)
This helps users on older supported versions find the right update.
Use Case
Publishing security fixes that were discovered through a responsible disclosure program, where the release notes must properly credit the reporter while avoiding information that could enable exploitation of unpatched systems.