feat: add target repo examples and file layout guidance
This commit is contained in:
26
README.md
26
README.md
@@ -15,8 +15,28 @@ This repo follows a hybrid model:
|
||||
|
||||
That avoids baking one project's assumptions into every other project, while still making the maintenance workflow reusable.
|
||||
|
||||
## Recommended target-repo layout
|
||||
|
||||
When this skill is applied to a real repository, prefer a structure like:
|
||||
|
||||
- `AGENTS.md`
|
||||
- `ai/project-map.md`
|
||||
- `ai/task-templates.md`
|
||||
- `ai/risk-guardrails.md`
|
||||
- `ai/harness-health.md`
|
||||
|
||||
Not every repository needs all files on day one. Start with `AGENTS.md`, then add the rest as the repo grows.
|
||||
|
||||
## Examples
|
||||
|
||||
- `examples/node-project/`
|
||||
- `examples/go-project/`
|
||||
- `examples/rust-project/`
|
||||
|
||||
These are sample outputs showing what project-local harness artifacts can look like.
|
||||
|
||||
## Suggested next steps
|
||||
|
||||
1. Add example target-repo outputs under a separate examples area if you want templates
|
||||
2. Add more stack references if your projects use specific frameworks
|
||||
3. Optionally create a second skill later for task-template generation only
|
||||
1. Add more stack references if your projects use specific frameworks
|
||||
2. Optionally create a second skill later for task-template generation only
|
||||
3. Add a small script to scaffold target-repo harness files from templates
|
||||
|
||||
Reference in New Issue
Block a user