Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (20 loc) · 864 Bytes

CONTRIBUTING.md

File metadata and controls

28 lines (20 loc) · 864 Bytes
Raw

Contributing to LayoutScope

LayoutScope aims to be deterministic, explainable, and conservative. The most valuable contributions are small reproducible pages that expose a false positive or a visual bug the current rules miss.

Development

pnpm install
pnpm exec playwright-core install chromium
pnpm check
pnpm build

Run the intentionally broken demo:

pnpm demo

Adding a rule

  1. Add a stable LS### rule definition in src/rules.ts.
  2. Implement the browser-side check in src/browser-detector.ts.
  3. Add a minimal fixture that fails for the right reason and a nearby non-failing case.
  4. Keep findings deterministic and include geometry or color evidence.
  5. Document known suppressions and limitations.

False-positive fixes are welcome even when they reduce the raw number of findings. Signal matters more than volume.