docs: add agent guidance and contributor setup#4
Merged
Conversation
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
This updates the repo guidance so contributors and coding agents can make smaller, more consistent changes with less unnecessary exploration. It adds a repo-specific
AGENTS.mdand a conciseCONTRIBUTING.mdthat explain how to work onagent-cdp, how CLI output should stay token-efficient, and how PRs should describe user impact, compatibility, risks, and manual testing.Backward Compatibility
There are no command, flag, output, artifact, or daemon behavior changes in this PR. The changes are documentation-only, so existing user workflows and scripts remain compatible.
Risks
AGENTS.md,CONTRIBUTING.md,src/cli.ts, andpackages/agent-cdp/skills/core.mdaligned.Manual testing
Scenario: validate that a new contributor or coding agent can discover the intended workflow without reading unrelated files.
Setup assumptions:
Steps:
AGENTS.mdand verify it contains the sectionsFirst Minute,Scope,Code Changes,Toolchain,Cheap Exploration,Command Family Lookup,Pull Requests, andPriority Order.AGENTS.mdincludes guidance to keep CLI output token-efficient, avoid JSON as the default output format, preserve daemon/session architecture boundaries, and updatesrc/cli.tspluspackages/agent-cdp/skills/core.mdwhen CLI workflows change.CONTRIBUTING.mdand verify it explains the repo-specific first-pass workflow, root validation commands, built CLI workflow, and the daemon/target/manual loop without duplicating obvious generic setup advice.Expected outcome:
agent-cdpchanges, where to look first, how to validate changes, and how to write a PR without needing extra project-specific tribal knowledge.