docs: add contribution baseline and AI use policy, trim agent guides - #703
Merged
Conversation
The root agent guide and the two per-example guides restated command tables, directory trees, account layouts, and toolchain pins that are all readable from the files themselves. Cut those and keep only the decisions and traps that the code does not show: workspace layout intent, litesvm override behavior, resolver-2 feature unification, keys-sync drift guard, and the gacha randomness trust model.
Adopt the shared Foundation contribution structure: before-you-start checklist with signed commits, private vulnerability reporting, development setup, change requirements, and PR expectations including Greptile resolution and Conventional Commits. Add an AI use section covering review responsibility, the AI code smells maintainers will close PRs over, disclosure, and reviewer communication, plus two rules specific to a teaching repo: do not obscure the pattern being taught, and do not fan a change across every framework flavor. Existing repo-specific rules (pnpm, non-workspace layout, path structure, LiteSVM, mandatory scripts, .ghaignore) are unchanged.
Contributor
Greptile SummaryThis documentation-only PR establishes a broader contribution and AI-use policy while reducing agent guides to repository-specific design decisions and traps.
Confidence Score: 4/5The PR appears safe to merge after clarifying the non-blocking test-command guidance for justfile-driven Pinocchio examples. The documentation changes preserve the checked game and repository invariants, with one misleading framework-wide command that sends contributors in two Pinocchio projects to a nonexistent package script. Files Needing Attention: CONTRIBUTING.md Important Files Changed
Reviews (1): Last reviewed commit: "docs(contributing): add contribution bas..." | Re-trigger Greptile |
amilz
approved these changes
Aug 27, 2026
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
CONTRIBUTING.md: adopt the shared Foundation contribution structure (before-you-start checklist with signed commits, private vulnerability reporting, development setup, change requirements, PR expectations with Greptile resolution and Conventional Commits, license) on top of the existing repo-specific rules, which are unchanged.CONTRIBUTING.md: new AI use section covering review responsibility, Solana Dev Skill / Solana MCP pointers, the AI code smells maintainers will close PRs over, disclosure, and reviewer communication. Two rules are specific to a teaching repo: generated code that obscures the pattern being taught is worse than none, and do not fan a change across every framework flavor unless it truly applies.AGENTS.md: cut command tables, toolchain-pin lists, and formatting/CI steps that are all readable frompackage.json,Anchor.toml, and the workflows. Kept only the non-obvious parts: why this is not a pnpm workspace, workspace-ignore enforcement, the litesvm0.8override silent-pass trap,node:test-under-mocha exiting 0, resolver-2 feature unification, and theanchor keys syncdrift guard. 4.4 KB to 2.3 KB.games/gacha/pinocchio/CLAUDE.mdandgames/world-cup/pinocchio/CLAUDE.md: same treatment. Droppedjustcommand tables, program file trees, account field dumps, and lifecycle walkthroughs; kept the design rationale (gacha's randomness and trust model, world-cup's total ranking key and folded scoring) and the traps (packed-field alignment, Codama literal-array limit, single-threaded light prover, devnet burst cost).Test Plan
pnpm check(prettier) was not run locally: the rootnode_modulesis not installed in this working copy. CI covers it.