Contributing
This package is maintained as an engineering playbook, not as marketing copy. Proposed changes should improve correctness, clarity, and practical usefulness.
Change Standard
Every contribution should answer three questions:
- What problem in the current guidance are you fixing?
- What stronger practice or control are you introducing?
- What tradeoff does the change create?
Expected Workflow
- Create a short-lived branch from the current default branch.
- Make the smallest coherent change that improves the playbook.
- Update affected playbooks, checklists, and templates together.
- Include rationale in the pull request.
- Do not merge guidance that you would not defend in a production review.
Review Expectations
- Prefer evidence and operating experience over preference.
- Call out risky absolutes such as "always" and "never" unless they are truly universal.
- Remove tool lock-in unless the repo explicitly intends to recommend a default.
- Check for broken links, contradictory guidance, and unsafe shortcuts.
Definition Of Done
- The guidance is internally consistent.
- Terminology is clear and stable.
- Checklists and templates reflect the updated rule.
- The change improves the enterprise readiness of the playbook.