docs: a contributing page for working on the system#551
Open
leeovery wants to merge 1 commit into
Open
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/contributing.md— everything indocs/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 toCLAUDE.md/CONVENTIONS.md./hooksshows nothing for an inactive agent, andhasCompletedProjectOnboardingcan readtruewhile trust is stillfalse— so an old checkout looks set up and quietly isn't. Includes a one-liner to check it.CHANGELOG.mdis generated, shipped.shmigrations are frozen. Plus the never-pipe-a-gate rule, which produced a falsely-green report before.README.mdanddocs/README.md.Deliberately thin — it grows as we hit things.
Test plan
🤖 Generated with Claude Code