Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (34 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

45 lines (34 loc) · 1.54 KB

Contributing

Thanks for your interest in improving the V11 Starter Pack.

How to Contribute

Report Issues

  • Open an issue describing the problem
  • Include which module or example is affected
  • Suggest a fix if you have one

Improve Documentation

  • Fix typos, unclear language, or missing context
  • Keep language accessible to beginners
  • Every concept should have a concrete example

Add Examples

  • New hook examples in modules/02-hooks/examples/
  • New formation patterns in modules/03-formations/examples/
  • New agent definitions in modules/06-agents/examples/
  • New project examples in examples/

Add or Improve Modules

  • Each module must be self-contained (no dependencies on other modules)
  • Include a README.md with concept explanation, usage guide, and CLAUDE.md snippet
  • Include working code examples

Guidelines

  1. Accessibility first. A beginner should be able to understand the README for any module.
  2. No external dependencies. Hook examples should only need bash and jq.
  3. Working examples. Every code snippet should be testable by piping JSON to it.
  4. No platform-specific code. This is a generic framework, not tied to any infrastructure.

Testing Hook Examples

# Test a guard hook
echo '{"tool_name":"Edit","tool_input":{"file_path":"src/app.py"}}' | bash modules/02-hooks/examples/guard-write
echo "Exit code: $?"

# Test a risk hook
echo '{"tool_name":"Bash","tool_input":{"command":"rm -rf /"}}' | bash modules/02-hooks/examples/guard-risk
echo "Exit code: $?"  # Should be 2 (blocked)