Skip to content

docs: a contributing page for working on the system#551

Open
leeovery wants to merge 1 commit into
fix/entry-handoff-fencesfrom
docs/contributing
Open

docs: a contributing page for working on the system#551
leeovery wants to merge 1 commit into
fix/entry-handoff-fencesfrom
docs/contributing

Conversation

@leeovery

Copy link
Copy Markdown
Owner

Summary

  • Adds docs/contributing.md — everything in docs/ describes the product; nothing described the repository that produces it. Covers clone-to-green setup, the four local gates (and that there is no CI), rebuilding the knowledge bundle, and pointers to CLAUDE.md / CONVENTIONS.md.
  • Documents the prerequisite that cost most of a session to find: frontmatter hooks in a project subagent only run once the workspace trust dialog has been accepted for the folder (2.1.218+), and until then they fail silently. /hooks shows nothing for an inactive agent, and hasCompletedProjectOnboarding can read true while trust is still false — so an old checkout looks set up and quietly isn't. Includes a one-liner to check it.
  • Other known hiccups: agent definitions are cached per session, snapshot drift after engine changes is expected and how to regenerate, CHANGELOG.md is generated, shipped .sh migrations are frozen. Plus the never-pipe-a-gate rule, which produced a falsely-green report before.
  • Linked from both README.md and docs/README.md.

Deliberately thin — it grows as we hit things.

Test plan

  • Docs only; no behaviour changes.
  • The trust-check one-liner in the page was run against this repo and returns the expected value.

🤖 Generated with Claude Code

Everything in docs/ describes the product; nothing described the
repository that produces it. This covers clone-to-green setup, the four
local gates (and that there is no CI), rebuilding the knowledge bundle,
and the conventions that are mandatory before editing skills.

The prose-test section carries the prerequisite that cost most of a
session to find: frontmatter hooks in a project subagent only run once
the workspace trust dialog is accepted for the folder, and until then
they fail silently — no warning, and /hooks shows nothing for an
inactive agent. hasCompletedProjectOnboarding can read true while trust
is still false, so an old checkout looks set up and quietly isn't.

Deliberately thin elsewhere; it grows as we hit things.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant