Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (24 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

38 lines (24 loc) · 1.95 KB
Raw

Contributing

Thanks for your interest in improving the Agentic Workspace Starter Kit.

This kit is a set of docs, templates, and small shell scripts. It practices what it teaches, so contributions follow the same conventions the kit itself documents.

Before you start

Read AGENTS.md — specifically Mode 2: improving the kit. It defines how the layers fit together and what "keep it generic" means. The directory and writing conventions live in docs/directory-and-naming-standard.md.

The pre-PR loop

Run these from the repo root before opening a pull request. CI runs the same checks, so passing locally means a green PR:

shellcheck scripts/*.sh templates/skills/*.sh   # scripts must be clean
./scripts/seed-sandbox.sh                        # regenerate the sandbox fixture
git diff --exit-code reference/sandbox           # sandbox must not drift
./scripts/validate-workspace.sh reference/sandbox # invariants must hold

If you changed templates or scripts that affect the sandbox, commit the regenerated reference/sandbox/ so the drift check stays green.

What good contributions look like

  • Keep guidance thin. AGENTS.md files carry boundaries and routing, not procedures. Reference; don't duplicate.
  • Keep templates generic. No client-specific or internal-specific content. Placeholders are clearly marked.
  • Match the house style. Lead with the answer, no em dashes, kebab-case directories, YAML frontmatter on docs.
  • Don't hand-edit the sandbox. It's generated by scripts/seed-sandbox.sh; change the seed and regenerate.

Releases

Version lives in CHANGELOG.md. To cut a release, add a dated section to the changelog and tag the commit (e.g., git tag v0.1.0). See CHANGELOG.md for the format.

Reporting problems

  • Bugs and workspace questions: open an issue (templates provided).
  • Security or sensitive-exposure concerns: see SECURITY.md.