Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (20 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

31 lines (20 loc) · 1.69 KB
Raw

Contributing

This is a starter — a clean, generic scaffold people fork and fill. Contributions that keep it that way are welcome.

Good contributions

  • New hooks — generic guardrails or automations (a useful PreToolUse check, a smarter session-start). Pure bash where possible; python3 is fine where you need to parse a payload. No other dependencies.
  • New ritual commands — a daily/weekly ritual that generalizes beyond one job.
  • New skill templates — a repeatable unit of work with a specific trigger description.
  • Docs and examples — clearer quickstart, a worked example for a different kind of work (research, support, content).

The one rule

Keep it generic. No real data, ever. No real company names, playbooks, pricing, credentials, or personal data — in code, commits, or examples. The demo/ folder is fictional and must stay that way. If a contribution only makes sense with your private content in it, it belongs in your fork, not here.

Conventions

  • Markdown for commands, skills, ops, and docs.
  • Commands and skills lead with a clear, specific description — it's the trigger.
  • Hooks must run with no setup and no secrets. Make destructive or blocking behavior obvious.
  • Keep the README skimmable; put depth in docs/.

Before you open a PR

  • Run /demo-briefing and confirm it still works.
  • Install and trip the commit guard: ln -s ../../.claude/hooks/pre-commit-guard.sh .git/hooks/pre-commit, then try committing a fake key — it should block.
  • Keep the diff focused; one idea per PR.

Code of conduct

By taking part, you agree to uphold our Code of Conduct — be kind, assume good intent, keep it professional.