Skip to content

Contributing

Before opening a pull request, run the local checks and read the bridge architecture page.

npm install
npm run check

Test Reports

Local reports generated with test:report:generate remain self-contained HTML. Combined CI reports use separate HTML, JavaScript and data files to avoid the GitHub file size limit. Download and extract the entire combined-test-report artifact, then open its directory:

npm run test:report:open -- --report /path/to/extracted-report

For a multi-file report, this command starts the installed Allure viewer. Keep it running while viewing the report; press Ctrl+C to stop it. GitHub Pages publication preserves the report resources in the separate reports repository.

Pull Request Checklist

  • npm run check passes.
  • New bridge behavior has tests.
  • Upstream Playwright MCP schemas, descriptions, and responses remain unchanged.
  • User-visible changes are documented.
  • CHANGELOG.md is updated for user-visible changes.
  • Security-sensitive changes are noted in the PR description.

Things Not To Do

  • Do not reintroduce the removed native browser adapter, tool registry, or capability model.
  • Do not write runtime logs to stdout; stdio is reserved for MCP JSON-RPC.
  • Do not add a dependency unless it is imported by runtime or tests.
  • Do not weaken TypeScript, ESLint, or Prettier settings to make a change pass.
  • Do not commit dist/, coverage/, artifacts/, site/, .venv-docs/, or node_modules/.

Security Issues

Report vulnerabilities through GitHub Security Advisories, not public issues. See SECURITY.md.