🤖 This is an automated PR from Repo Assist.
Summary
This PR adds an AGENTS.md file — a conventions guide specifically aimed at AI coding assistants (and human contributors) working on this repository.
Why AGENTS.md?
Without this file, AI tools must rediscover project conventions on every run by reading source files. More critically, they repeatedly attempt changes that cannot succeed — such as opening PRs that modify package.json (a protected file), then creating issues asking a maintainer to apply the change manually. AGENTS.md short-circuits that wasted cycle.
What It Documents
- Protected files:
package.json and .github/workflows/** cannot be modified by automated PRs — create an issue instead
- Test infrastructure: how to run the unit test suite (
node --test test/unit.test.js); which tests work headless vs require VS Code
- Coding conventions: CommonJS, 4-space indentation, no new runtime dependencies, match surrounding style
- Architecture notes:
PHPCBF class layout, temp file lifecycle, why lib/utils.js must stay free of vscode imports
- PR checklist: run tests, keep PRs focused, document any required
package.json changes in the issue
Test Status
✔ findFiles (7/7 passing, 63ms) — no regressions
Documentation-only change; no runtime code was modified.
Generated by Repo Assist · ◷
To install this agentic workflow, run
gh aw add githubnext/agentics/workflows/repo-assist.md@346204513ecfa08b81566450d7d599556807389f
To route changes like this to a review issue instead of blocking, configure protected-files: fallback-to-issue in your workflow configuration.
🤖 This is an automated PR from Repo Assist.
Summary
This PR adds an
AGENTS.mdfile — a conventions guide specifically aimed at AI coding assistants (and human contributors) working on this repository.Why AGENTS.md?
Without this file, AI tools must rediscover project conventions on every run by reading source files. More critically, they repeatedly attempt changes that cannot succeed — such as opening PRs that modify
package.json(a protected file), then creating issues asking a maintainer to apply the change manually.AGENTS.mdshort-circuits that wasted cycle.What It Documents
package.jsonand.github/workflows/**cannot be modified by automated PRs — create an issue insteadnode --test test/unit.test.js); which tests work headless vs require VS CodePHPCBFclass layout, temp file lifecycle, whylib/utils.jsmust stay free ofvscodeimportspackage.jsonchanges in the issueTest Status
Documentation-only change; no runtime code was modified.
Warning
🛡️ Protected Files
This was originally intended as a pull request, but the patch modifies protected files:
AGENTS.md.These files may affect project dependencies, CI/CD pipelines, or agent behaviour. Please review the changes carefully before creating the pull request.
Click here to create the pull request once you have reviewed the changes
To route changes like this to a review issue instead of blocking, configure
protected-files: fallback-to-issuein your workflow configuration.