Skip to content

chore: add agent development files (AGENTS.md) - #2249

Merged
dprevost-LMI merged 3 commits into
webdriverio:mainfrom
dprevost-LMI:add-agents-md
Sep 27, 2026
Merged

dprevost-LMI merged 3 commits into
webdriverio:mainfrom
dprevost-LMI:add-agents-md

Conversation

@dprevost-LMI

Copy link
Copy Markdown
Collaborator

Proposed changes

Closes #2248

Add agent development files, the same as WebdriverIO did on v10 (webdriverio/webdriverio#15671):

  • AGENTS.md: the one source of rules for all coding agents. It has the repo map, setup, the files not to edit by hand, the test selection table, the multi-remote naming rule and check, and the working agreement.
  • CLAUDE.md and .github/instructions/copilot.instructions.md: short adapters that only point to AGENTS.md.
  • .agents/skills/verify-expect-webdriverio/SKILL.md: how to prove a change in a playground. It covers which playground to run for each type of change, the commands, and the proof to put in the PR.
  • .github/PULL_REQUEST_TEMPLATE.md: a new PR template with a "How you tested" section.
  • .gitignore: ignore .agents/verify-artifacts.
  • test/__mocks__/@wdio/globals.ts: a comment now says multi-remote instead of multiremote, so the naming check passes.

Notes:

  • Coverage is on by default, with global thresholds. A single-file Vitest run fails those thresholds, so the single-file commands include --coverage.enabled=false.
  • The naming check allows the WebdriverIO v9 names that this repo cannot rename (isMultiremote, MultiremoteConfig, multiremotebrowser), the /docs/multiremote links, and the WebdriverIO error text in mocks. The isMultiRemote rename in v10 can remove these exceptions.
  • Not in this PR: an add-matcher skill, and the .agents/setup / .agents/resume scripts. The add-matcher skill is easier to write after the generic matcher work.

How you tested

  • npx vitest --run --coverage.enabled=false: 2629 passed
  • WDIO_ENABLE_MULTI_REMOTE_ELEMENT_ARRAY=true npx vitest --run --coverage.enabled=false: 2629 passed
  • The multi-remote naming check in AGENTS.md prints nothing
  • All relative links in the new files resolve
  • npx eslint . passes

The playground commands in the skill were not run. I only checked that the paths and workspace names exist.

Types of changes

  • Polish (an improvement for an existing feature)
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Internal updates (scripts, CI, repository files)

🤖 Generated with Claude Code

Add AGENTS.md as the one source of rules for coding agents, with thin
CLAUDE.md and Copilot adapters, the verify-expect-webdriverio skill and
a "How you tested" section in a new PR template, the same as WebdriverIO.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@dprevost-LMI
dprevost-LMI marked this pull request as ready for review September 27, 2026 20:33
@greptile-apps

greptile-apps Bot commented Sep 27, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 5/5

[Low risk] Adds agent development and documentation files.

The PR appears safe to merge based on the reviewed changes.

Summary

The PR adds a canonical agent guide, tool-specific pointers, a playground verification skill, and a PR testing template. Since the previous review, it also corrects matcher test guidance, the snapshot command, and the naming check.

  • The three previous findings appear fixed.
  • No new actionable issue was established.

Reviews (2) · Last reviewed commit: "docs: fix test paths, snapshot command a..."

Comment thread AGENTS.md Resolved
Comment thread AGENTS.md Resolved
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@dprevost-LMI
dprevost-LMI merged commit d53e3a8 into webdriverio:main Sep 27, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[v8] Add agent development files (AGENTS.md), the same as WebdriverIO

1 participant