Skip to content

Commit a14158a

Browse files
committed
[docs] Expand contributor guidance (#37)
1 parent 76687f0 commit a14158a

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,13 @@ Thanks for helping improve FastForward DevTools.
1717
composer dev-tools
1818
```
1919

20+
4. Read the project guidance before making structural changes:
21+
22+
- `README.md` for the public command surface and contributor workflow
23+
- `docs/` for the generated-user documentation structure
24+
- `AGENTS.md` for repository-specific engineering patterns, project agents,
25+
and skill usage
26+
2027
## Development Workflow
2128

2229
Use the Composer commands exposed by the package during normal development:
@@ -32,6 +39,19 @@ composer dev-tools:sync
3239
Focused checks are fine while iterating, but please run the relevant
3340
verification for the files you changed before opening a pull request.
3441

42+
If you contribute with Codex or project agents, prefer the packaged workflow
43+
helpers that already exist in this repository:
44+
45+
- `.agents/skills/github-pull-request/` for issue-to-branch-to-PR flow
46+
- `.agents/skills/github-issues/` for issue drafting and updates
47+
- `.agents/skills/phpunit-tests/` for focused PHPUnit coverage work
48+
- `.agents/skills/phpdoc-code-style/` for PHPDoc and repository PHP style
49+
- `.agents/skills/package-readme/` and `.agents/skills/sphinx-docs/` for
50+
README and `docs/` updates
51+
- `.agents/agents/` for repository-specific role prompts such as
52+
`docs-writer`, `readme-maintainer`, `consumer-sync-auditor`, and
53+
`changelog-maintainer`
54+
3555
## Coding Standards
3656

3757
- Follow the repository PHP style and architecture patterns already in `src/`
@@ -40,6 +60,10 @@ verification for the files you changed before opening a pull request.
4060
into dedicated collaborators.
4161
- Update documentation when a change affects commands, workflows, generated
4262
outputs, or consumer onboarding.
63+
- Respect the current command bootstrapping and dependency-injection patterns
64+
described in `AGENTS.md` and `docs/internals/architecture.rst`.
65+
- Keep generated or synchronized surfaces consistent when a change affects
66+
workflows, wiki output, consumer sync assets, or packaged skills.
4367

4468
## Changelog Expectations
4569

0 commit comments

Comments
 (0)