Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (37 loc) · 989 Bytes

CONTRIBUTING.md

File metadata and controls

54 lines (37 loc) · 989 Bytes

Contributing

Welcome! We appreciate your interest in contributing to this project.

Dev setup

bun install
npx playwright install chromium firefox webkit

Running

node src/run.js examples/todomvc.json   # Run an example scenario

Scenarios must be run with node, not bun — bun + Playwright hangs on browser launch on Windows.

Testing

bun test            # Run tests
bun run format      # Format code

Making changes

  1. Create a feature branch
  2. Make changes
  3. Add tests if applicable
  4. Run bun run format before committing
  5. Commit with a clear message

Commit messages

Use Conventional Commits:

<type>: <subject>

[optional body]

Types: feat, fix, docs, refactor, test, chore

Examples:

feat: add scroll action
fix: handle missing selector in click
docs: clarify scenario schema

Keep subjects under 50 characters. Use body for "why", not "what".