Description
Alerts fire without clear pointers to their runbook. Author docs/runbooks/README.md mapping every alert name to its runbook, owner, and expected first response.
Requirements and context
- Must be secure, tested, and documented
- Should be efficient and easy to review
- Relevant code:
docs/runbooks/, alert templates
- CI check verifies every alert has a mapping entry
Suggested execution
- Fork the repo and create a branch
git checkout -b docs/incident-response-playbook
- Implement changes
- Author mapping table
- Add CI check parsing alert names
- Reference runbook URLs in alert templates
- Validate security and correctness assumptions
Test and commit
- Run tests
- Cover edge cases
- New alert missing mapping fails CI
- Include test output and notes
Example commit message
docs: alert-to-runbook mapping
Guidelines
- Minimum 95 percent test coverage
- Clear documentation
- Timeframe: 96 hours
Description
Alerts fire without clear pointers to their runbook. Author
docs/runbooks/README.mdmapping every alert name to its runbook, owner, and expected first response.Requirements and context
docs/runbooks/, alert templatesSuggested execution
git checkout -b docs/incident-response-playbookTest and commit
npm testExample commit message
docs: alert-to-runbook mappingGuidelines