You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Generate or refresh repository-level AGENTS.md files with actionable setup, workflow, testing, style, and contribution guidance for coding agents. Use when a repository is missing AGENTS.md, when an existing AGENTS.md is stale, or when agent-facing project instructions need to be aligned with the current checkout.
4
+
---
5
+
6
+
# Fast Forward AGENTS.md
7
+
8
+
Use this skill to create or refresh a repository-root `AGENTS.md` that helps
9
+
coding agents work effectively in the current project. Keep the file specific to
10
+
the checked-out repository, verify commands and paths before writing them, and
11
+
prefer concise instructions over generic explanations.
12
+
13
+
## Workflow
14
+
15
+
1. Inspect the repository first: language, package manager, build and test
16
+
entrypoints, CI workflows, docs, and any existing `AGENTS.md`.
17
+
2. Decide whether to create or update:
18
+
- create `AGENTS.md` at the repository root when the file is missing;
19
+
- update the existing file in place when it already contains repository-specific
20
+
guidance worth preserving.
21
+
3. Capture only repository-relevant instructions that an agent would not safely
22
+
infer from code alone.
23
+
4. Verify every command, path, workflow name, and generated artifact reference
24
+
against the current checkout before finalizing the file.
25
+
5. Keep the result aligned with the public `agents.md` guidance without copying
26
+
generic filler into the repository.
27
+
28
+
## Required Coverage
29
+
30
+
- Project overview and architecture cues that affect implementation work
31
+
- Setup, installation, and local development commands
32
+
- Testing commands, focused test patterns, and quality gates
33
+
- Code style, file-organization, and naming expectations that matter in review
34
+
- Build, release, or deployment behavior when the repository exposes one
35
+
- Pull request or contribution rules when they are discoverable from local files
36
+
- Notable repository references such as `README.md`, `docs/`, workflow files, or
37
+
generated-output locations when those links help an agent navigate the project
38
+
39
+
## Writing Rules
40
+
41
+
- Use direct, actionable language aimed at another coding agent.
42
+
- Prefer exact commands in backticks instead of vague descriptions.
43
+
- Mention real paths, scripts, workflow files, and generated outputs.
44
+
- Keep `AGENTS.md` as a companion to `README.md`, not a duplicate of it.
45
+
- Add links or path references to canonical repository surfaces when they are
46
+
useful entrypoints for agents, especially `README.md`, `docs/`, `.github/workflows/`,
47
+
and other notable local documentation or output directories.
48
+
- Call out monorepo or nested-`AGENTS.md` precedence only when it actually applies.
49
+
- Preserve valid repository-specific guidance when updating an existing file.
50
+
- Do not invent commands, services, environment variables, or workflows that are
51
+
not present in the checkout.
52
+
53
+
## Reference Guide
54
+
55
+
| Need | Reference |
56
+
|------|-----------|
57
+
| Section planning and optional coverage |[references/content-outline.md](references/content-outline.md)|
58
+
| Final quality checks before finishing the file |[references/content-outline.md](references/content-outline.md)|
59
+
60
+
## Anti-patterns
61
+
62
+
- Do not paste a generic AGENTS template without inspecting the repository.
63
+
- Do not describe tools or frameworks that are not present in the checkout.
64
+
- Do not duplicate large sections of `README.md` when a short cross-reference is
65
+
enough.
66
+
- Do not leave placeholder text, TODO markers, or fake commands in the file.
67
+
- Do not rewrite a good existing `AGENTS.md` from scratch when a focused refresh
- Follow `.github/pull_request_template.md` and include issue linkage,
161
+
verification notes, documentation/generated-output review, and changelog
162
+
status
163
+
164
+
## Canonical References
165
+
166
+
-`README.md`: high-level command surface, architecture overview, and consumer-facing context
167
+
-`docs/commands/`: command-specific behavior and option details
168
+
-`docs/usage/` and `docs/internals/`: workflow, reporting, release, and implementation notes
169
+
-`.github/workflows/`: CI and release automation truth, especially `tests.yml`, `reports.yml`, `wiki.yml`, and `changelog.yml`
170
+
-`.github/pull_request_template.md`: expected PR structure and reviewer checklist
171
+
-`.agents/skills/`: packaged procedural skills shipped to consumer repositories
172
+
-`.agents/agents/`: repository-specific role prompts mirrored through `.github/agents`
173
+
-`.github/wiki`: generated or synchronized wiki content published by repo workflows
141
174
142
175
## Additional Notes
143
176
@@ -150,6 +183,7 @@ composer dev-tools
150
183
## Skills Usage
151
184
152
185
-**Creating/Updating Tests**: Use skill `phpunit-tests` in `.agents/skills/phpunit-tests/` for PHPUnit tests with Prophecy
186
+
-**Creating/Refreshing AGENTS.md**: Use skill `create-agentsmd` in `.agents/skills/create-agentsmd/` to generate or update repository-root AGENTS instructions for coding agents
153
187
-**Generating Documentation**: Use skill `sphinx-docs` in `.agents/skills/sphinx-docs/` for Sphinx documentation in `docs/`
154
188
-**Updating README**: Use skill `package-readme` in `.agents/skills/package-readme/` for generating README.md files
155
189
-**Updating PHPDoc / PHP Style**: Use skill `phpdoc-code-style` in `.agents/skills/phpdoc-code-style/` for PHPDoc cleanup and repository-specific PHP formatting
@@ -165,6 +199,7 @@ procedural source of truth.
165
199
166
200
- Use `issue-editor` for issue drafting, refinement, comments, updates, and closure workflows.
167
201
- Use `issue-implementer` for issue-to-branch-to-PR execution.
202
+
- Delegate to `agents-maintainer` when repository `AGENTS.md` guidance needs to be created, refreshed, or realigned with current workflows.
168
203
- Delegate to `test-guardian` whenever behavior changes, regressions, or missing coverage are involved.
169
204
- Delegate to `php-style-curator` for PHPDoc cleanup, file-header normalization, and repository style conformance.
170
205
- Delegate to `readme-maintainer` when public commands, installation, usage, links, or badges change.
0 commit comments