Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 2.23 KB

File metadata and controls

37 lines (24 loc) · 2.23 KB

Matterbridge Agents Instructions (v.1.0.2)

Style And Formatting

  • Follow STYLEGUIDE.md for code style, naming, JSDoc, validation, logging, and formatting expectations.
  • JSDoc requirements are enforced by the linter. Treat missing or incomplete JSDoc on required APIs as a real lint issue, not optional documentation.
  • Import and export ordering are enforced by the linter or by the formatter. Preserve the existing grouped and sorted order unless a change requires updating it.
  • Follow the existing formatting and do not fight the formatter.

Scope And Safety

  • Keep changes minimal and scoped to the request. Avoid unrelated refactors or broad cleanup.
  • Do not modify production code only to make a test pass. If a failing test points to a likely source issue, explain the issue and change behavior only when required by the task.
  • Preserve cross-platform behavior. Changes must work on Windows, macOS, and Linux, especially for paths, shell commands, environment variables, and networking behavior.
  • Maintain compatibility with the supported Node.js versions in this repository: 20.19, 22.13, 24 and 26.

Project Architecture

  • This repository is a TypeScript ESM repo. Follow existing project patterns for imports, exports, build configuration, and test setup.

Testing And Validation

  • Prefer the existing npm scripts in package.json and the VS Code tasks in tasks.json when validating changes.
  • Keep tests deterministic and simple. Prefer small data sets and straightforward setup.
  • Some tests are intentionally multi-step flows. State may persist across successive steps within a single test flow, but each test unit must remain isolated from other tests.
  • For validation, run the relevant full test file or the matching suite/task for the touched area rather than assuming arbitrary isolated single-test execution is reliable.

Documentation

  • When behavior changes, update the relevant tests and documentation in the README.md files.

Additional Agent Guidance

For task-specific guidance, read relevant files in .agents:

  • .agents/testing.md for testing and validation expectations;
  • .agents/matterbridge.md for instruction about using matterbridge in a plugin.