Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (40 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

58 lines (40 loc) · 1.59 KB
Raw

Contributing

The Lore JavaScript SDK follows the Lore project contribution process. Issues and pull requests are welcome in this repository.

Prerequisites

  • Node.js 20+ and pnpm 10 — see packageManager in package.json
  • Python 3.10+ — required by the binding generator, with uv for dependency management

Build and test

uv venv .venv && source .venv/bin/activate
uv pip install jinja2 pycparser
pnpm install --frozen-lockfile
uv run python find_lorelib.py
uv run python generator/generate.py
pnpm run build

Run the tests:

pnpm test

This runs vitest plus the CommonJS smoke test (src/cjs/smoke.cjs).

Formatting

Formatting is enforced by CI and must pass before any PR is merged:

pnpm run prettier:format

Before you code

For anything beyond a trivial fix, open a GitHub Issue and wait for a maintainer to weigh in before investing significant effort. Changes to the wire protocol or lore-capi belong in the Lore repository, not here.

Commit sign-off

Every commit must include a Signed-off-by: line. Add it with git commit -s. The DCO, patent affirmation, copyright header rules, and license compatibility policy are all defined in the canonical contributing doc.

Full contribution policy

The full PR process, review process, AI assistance policy, legal terms, and community channels are published in the Lore repository:

→ Lore CONTRIBUTING.md