Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
27 lines (19 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

27 lines (19 loc) · 1.01 KB
Raw

Contributing to shell-framework

This repo is the extension host for OpenShellOrg. Architecture and thesis live in shell-architecture.

Layout

  • src/ — host implementation (manifest loading, registration, discovery, PATH/import() loading)
  • schemas/ — JSON Schema for manifests
  • docs/ — manifest reference, distribution model, architecture cross-links
  • manifests/core/ — JSON manifests that point at upstream repos; never vendor extension source here
  • test/ — Node test runner checks against built dist/

Adding a core extension

  1. Add manifests/core/<name>.manifest.json following the schema in docs/extension-manifest.md.
  2. Register the file path in manifests/core.index.json.
  3. Extend tests if the extension has required fields beyond the base schema.

Development

pnpm install
pnpm build
pnpm test

Pull requests should keep CI green (pnpm test runs typecheck, build, and tests).