Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (41 loc) · 915 Bytes

CONTRIBUTING.md

File metadata and controls

62 lines (41 loc) · 915 Bytes

Contributing to paneweave

Thanks for contributing.

Local Setup

npm install

Development Workflow

  1. Make focused changes.
  2. Keep package app-agnostic.
  3. Do not edit dist/ by hand.
  4. Preserve public API unless change is intentional.

Validation

Run package validation:

npm test

If runtime behavior changed, also validate the example consumer:

cd examples/zustand-react
npm run build

Build Artifacts

Build output goes to dist/:

npm run build

Publishing

Dry run first:

npm run deploy:dry

Publish:

npm run deploy

Before publish, ensure package.json version is greater than the latest published version.

Style Expectations

  • Prefer minimal, local edits over broad refactors.
  • Add tests when behavior changes.
  • Keep TypeScript strictness intact.
  • Keep CSS class contract stable unless intentional.