Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (29 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 1.54 KB
Raw

Contributing to World Model

Thanks for being here. World Model is an MIT-licensed engine in the Meterless stack and contributions are very welcome.

Ways to help

  • Use it and report bugs. A working bug report with a minimal repro is the highest-leverage contribution.
  • Improve docs. If something in /docs or /workshops confused you, fix it. Doc PRs are merged fast.
  • Add an example. Examples in /examples are the front door for new users.
  • Build a custom view library. Domain-specific views (CRM, fintech, gaming) are great as separate packages that depend on @meterless/world-model.
  • Extend the control plane. Custom panels and merge UIs are first-class.

Getting set up

git clone https://github.com/meterless/world-model
cd world-model
npm install
npm test

PR conventions

  • One concern per PR. Smaller is faster to merge.
  • Tests for every behavior change. Vitest, colocated with source.
  • Doc updates land in the same PR as the behavior change.
  • Conventional Commits: feat:, fix:, docs:, refactor:, test:, chore:.

What we won't merge

  • New write operations on the canonical store outside the five primitives. The write surface is deliberately small.
  • View implementations that mutate canonical state.
  • Anything that breaks idempotency at the event-log layer.

If you're not sure, open a discussion before writing the code.

Code of conduct

Be kind. Disagreements about code are fine. Disagreements about people aren't.

License

By contributing you agree your contributions are MIT-licensed.