Add agent support templates and profiles
This commit is contained in:
@@ -66,6 +66,10 @@ Use only the files that fit the project. For a tiny script repo, `AGENTS.md`, `R
|
||||
| `files/blueprint.json` | `blueprint.json` |
|
||||
| `files/SECURITY.md` | `SECURITY.md` |
|
||||
| `files/CHANGELOG.md` | `CHANGELOG.md` |
|
||||
| `files/CONTRIBUTING.md` | `CONTRIBUTING.md` |
|
||||
| `files/gitignore.template` | `.gitignore` |
|
||||
| `files/agent-handoff.md` | `docs/agent-handoff.md` |
|
||||
| `files/release-notes.md` | `docs/release-notes.md` |
|
||||
|
||||
Start with `agent-quickstart.md` when using this kit through Codex.
|
||||
|
||||
@@ -73,6 +77,8 @@ Start with `agent-quickstart.md` when using this kit through Codex.
|
||||
|
||||
Agents should read `manifest.json` before copying files. It is the source of truth for target paths, required files, optional files, and placeholder names.
|
||||
|
||||
`manifest.schema.json` documents the manifest shape. Stack-specific profile notes live in `profiles/`.
|
||||
|
||||
<p align="center"><img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png" alt="-----------------------------------------------------" width="100%"></p>
|
||||
|
||||
## Placeholders
|
||||
@@ -108,6 +114,7 @@ When applying this kit, an agent should:
|
||||
|
||||
- read `manifest.json` first,
|
||||
- choose `new-repository.md` or `existing-project.md`,
|
||||
- read matching `profiles/*.md` guidance after detecting the stack,
|
||||
- check `git status --short` before editing,
|
||||
- preserve unrelated user changes,
|
||||
- use the manifest copy map for target paths,
|
||||
@@ -116,6 +123,7 @@ When applying this kit, an agent should:
|
||||
- keep `AGENTS.md` and `.codex/project.md` aligned,
|
||||
- update `README.md` whenever README blueprint files change,
|
||||
- update security and release docs when release behavior changes,
|
||||
- update `docs/agent-handoff.md` when work is interrupted, risky, or multi-session,
|
||||
- run `git diff --check` before finishing,
|
||||
- run the cheapest reliable verification command,
|
||||
- poll pushed Gitea workflow runs until success or a concrete blocker.
|
||||
|
||||
Reference in New Issue
Block a user