Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (33 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

48 lines (33 loc) · 1.47 KB
Raw

Contributing

Thanks for improving this repository.

Scope

  • packages/react-json-logic: publishable library package
  • apps/example: demo application package

Local Setup

Use Node 24.18 or newer with Corepack enabled, then run from the workspace root:

pnpm install --frozen-lockfile
pnpm verify

Daily Workflow

Use the root scripts as the canonical entrypoints:

pnpm check
pnpm test
pnpm build
pnpm dev:example
pnpm build:example

Per-package work is also supported:

cd packages/react-json-logic
pnpm exec vp run verify

Commit and Pull Request Rules

  • Use Conventional Commits (feat:, fix:, docs:, chore:, refactor:, test:, ci:)
  • Keep each pull request focused on one concern
  • Fill out the pull request template
  • Include validation evidence (at minimum pnpm verify)

Release and Deployment Notes

  • On every push to main that is not tagged [skip ci], CI runs verify and then semantic-release for packages/react-json-logic (Conventional Commits → version bump and npm publish, when applicable). Publishing uses npm Trusted Publishing (OIDC): the release job grants id-token: write and does not use an NPM_TOKEN secret. GitHub Release and version push-back commits are authored by uinaf-releaser[bot] via a short-lived App installation token from the release Environment.
  • The demo app deploy is configured through the repository host dashboard