Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (34 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

50 lines (34 loc) · 1.46 KB
Raw

Contributing

Opcore is a public alpha for local code intelligence, edit planning, and pre-write validation for coding agents.

Setup

npm ci
npm run build
npm test

Before A Pull Request

Run:

npm run ci

For packaging or release changes, also run:

npm run release:dry-run
npm run release:hygiene
npm run pack:check

Maintainers may also run:

npm run ci:local

ci:local includes maintainer-only current-tool validation and should not be required for ordinary downstream users.

Package Boundaries

  • Graph extraction, persistence, query, search, and impact belong in @the-open-engine/opcore-graph.
  • Edit planning, patch/tree planning, symbol edit previews, and validation-gated apply belong in @the-open-engine/lattice-edit.
  • Validation scopes, overlays, graph-provider policy, and check/validate adapters belong in @the-open-engine/lattice-validation.
  • TypeScript-specific checks belong in @the-open-engine/lattice-validation-typescript.
  • Shared types, schemas, command envelopes, and validation helpers belong in @the-open-engine/opcore-contracts.
  • CLI composition, help, status, doctor, and descriptor output belong in @the-open-engine/lattice-cli.

Do not expose old command aliases or new bins. The public CLI bin is lattice.

Release Line

The first public line is 0.1.x. Pre-1.0 releases may change contracts, but changes should be documented in CHANGELOG.md and reflected in JSON schema tests.