Skip to content

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:

  1. What problem in the current guidance are you fixing?
  2. What stronger practice or control are you introducing?
  3. What tradeoff does the change create?

Expected Workflow ​

  1. Create a short-lived branch from the current default branch.
  2. Make the smallest coherent change that improves the playbook.
  3. Update affected playbooks, checklists, and templates together.
  4. Include rationale in the pull request.
  5. 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.