3.7 KiB
3.7 KiB
Install and Copy Guide
Use this guide to copy the instruction suite into another repository without bloating the destination or confusing the agent.
Recommended Install
Copy these items into the target repository root:
AGENTS.mdDEPLOYMENT-PROFILE.mdSKILLS.mdPROJECT-PROFILE-WORKBOOK.mdROUTING-EXAMPLES.mdhubs/skills/
Optional:
README.mdif you want human-facing explanation of the bundle in the destination repo
Fast Copy Workflow
From this repository root, copy the suite into another repo root while excluding .git:
Copy-Item AGENTS.md,DEPLOYMENT-PROFILE.md,SKILLS.md,PROJECT-PROFILE-WORKBOOK.md,ROUTING-EXAMPLES.md -Destination <target-repo>
Copy-Item hubs -Destination <target-repo> -Recurse
Copy-Item skills -Destination <target-repo> -Recurse
If you also want the explanatory readme:
Copy-Item README.md -Destination <target-repo>
Prefill Workflow
Before deployment:
- Fill out
PROJECT-PROFILE-WORKBOOK.md. - Translate the answers into agent-facing defaults in
DEPLOYMENT-PROFILE.md. - Keep the deployment profile concise so it can be read early without wasting context.
- Copy the suite with the filled-in deployment profile included.
At runtime:
- The agent reads
AGENTS.md. - The agent reads
DEPLOYMENT-PROFILE.mdif it is filled in. - The agent reads
SKILLS.md. - The agent opens the relevant hub and specialized skill files only as needed.
Minimal Install
If the target repository wants the smallest useful setup, copy:
AGENTS.mdDEPLOYMENT-PROFILE.mdSKILLS.mdhubs/- only the skill files the team expects to use often
Good minimal baseline:
skills/software/repo-exploration.mdskills/software/feature-implementation.mdskills/software/test-strategy.mdskills/software/code-review.mdskills/debugging/bug-triage.mdskills/debugging/debugging-workflow.mdskills/documentation/technical-docs.mdskills/ui-ux/ux-review.md
How To Customize Safely
- Keep
AGENTS.mdshort and stable; put detail in hubs and skill files. - Add repo-specific instructions near the top of
AGENTS.mdor in existing repo instruction files. - Treat
DEPLOYMENT-PROFILE.mdas the canonical place for staged build, tool, environment, and workflow defaults. - Prefer editing hub routing before adding more root-level rules.
- Add new skill files only when they introduce a distinct workflow, risk area, or deliverable.
- If two skills overlap heavily, merge them or make the routing distinction explicit.
Context Limit Guidance
- Do not instruct the agent to load the entire
skills/tree on every task. - Keep the default path to one hub plus two to four specialized skills.
- Reserve four to six skills for large cross-functional tasks.
- Use the routing examples to confirm the suite still routes clearly after customization.
Updating The Bundle
- Pull improvements from this source repository into destination repos periodically.
- Refill the workbook and refresh the deployment profile when your preferred defaults change materially.
- Review local customizations before overwriting shared files.
- If a destination repo has stronger local conventions, keep those and treat this suite as the fallback layer.
Suggested Verification After Copying
Check that the destination repo can answer these questions clearly:
- Where does the agent start?
AGENTS.md - Where does the agent get preloaded defaults?
DEPLOYMENT-PROFILE.md - Where does the agent look for available skills?
SKILLS.md - How does the agent decide what to read next? Deployment profile, hubs, and routing examples
- Does the repo still prioritize local instructions over the generic bundle? It should