Contribute a production-earned pattern
Turn a reproducible engineering lesson into a reviewable Playbook pattern, prompt, template, or gate.
Contribute a production-earned pattern
The Playbook grows from evidence, not taste. A strong contribution starts with a failure you can reproduce, names the rule that prevents it, and includes a way to verify the rule in practice.
Choose the right contribution
| You have… | Contribute… | Include… |
|---|---|---|
| a recurring engineering failure | a pattern | trigger, rule, failure mode, enforcement |
| a reliable agent instruction | a prompt | role, inputs, outputs, refusal boundary |
| a durable document shape | a template | required sections and lifecycle |
| an automatable invariant | a gate script | actionable failure output and clean exit behavior |
| a correction or clearer explanation | a docs fix | source or reproduction showing why |
Quality bar
- Explain the human outcome in plain language.
- Give agents unambiguous instructions and concrete paths.
- Link the real incident, repeated defect, measurement, or upstream contract that earned the rule.
- Add copy-ready examples that a reader can run or adapt.
- Identify when the pattern does not apply.
- Update related pages instead of leaving duplicate or contradictory guidance.
- Run the corpus, Doc Bridge, deterministic artifact, README, and production-build gates.
Contribution flow
flowchart LR
F["Reproducible failure"] --> P["Pattern or artifact"]
P --> E["Example + enforcement"]
E --> X["Cross-links + agent handoff"]
X --> G["Automated gates"]
G --> R["Human review"]Read the repository CONTRIBUTING guide, open a focused pull request, and describe both the promise and the proof. The corpus is licensed under CC-BY-4.0, so teams may adapt it with attribution.
If your contribution is a ready-to-run agent rather than an engineering practice, submit it to the AgentsKit Registry. If it improves the shared chat runtime, start with the AgentsKit Chat documentation and its machine-readable map. If it improves repository-to-agent documentation routing, start with the Doc Bridge documentation and its machine-readable map.
For a repeatable review of an agent-authored pull request before submission, use the AgentsKit Code Review CLI and feed any reusable production lesson back into this Playbook.