24 lines
1.3 KiB
Markdown
24 lines
1.3 KiB
Markdown
# Contributing to DevRunbook
|
|
|
|
This build pack is Git-first. Product and playbook changes should be reviewable as ordinary file diffs and must preserve deterministic import and rendering.
|
|
|
|
## Before changing contracts
|
|
|
|
1. Read `AGENTS.md`, `docs/07-playbook-package-spec.md`, `docs/20-content-governance.md` and `docs/29-package-integrity-canonicalization.md`.
|
|
2. Run `python3 scripts/validate_pack.py`.
|
|
3. Update schemas, prose contracts, examples, API/database references and traceability together when a domain contract changes.
|
|
|
|
## Playbook contribution rules
|
|
|
|
- Start from `templates/playbook-package/`.
|
|
- Use a globally unique logical ID, slug and semantic version.
|
|
- Declare every package file and role.
|
|
- Include explicit use/non-use cases, guardrails, workflow, validation, completion and failure handling.
|
|
- Add at least one valid input example and one structural evaluation case.
|
|
- Do not claim `validated` or `battle-tested` lifecycle status without executed evidence.
|
|
- Never include secrets, proprietary repository content or instructions that weaken platform guardrails.
|
|
|
|
## Pull-request evidence
|
|
|
|
Describe the user outcome, changed contracts, migration impact, validation commands and any accepted limitation. Contract changes require a changelog entry and, when durable, a decision-log or ADR update.
|