Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
40 lines (27 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

40 lines (27 loc) · 1.14 KB
Raw

Contributing to stream-json

Thank you for your interest in contributing!

Getting started

This project uses a git submodule for the wiki. Clone recursively:

git clone --recursive https://github.com/uhop/stream-json.git
cd stream-json
npm install

See ARCHITECTURE.md for the module map and dependency graph.

Development workflow

  1. Make your changes.
  2. Lint: npm run lint:fix
  3. Test: npm test
  4. Type-check: npm run ts-check

Code style

  • ESM (import) throughout — source and tests ("type": "module"). No CommonJS, no transpilation.
  • Formatted with Prettier — see .prettierrc for settings.
  • One runtime dependency: stream-chain. Do not add others.
  • Keep .js and .d.ts files in sync for all modules under src/.

License

This project is distributed under the BSD-3-Clause license. External contributions are accepted only under licenses compatible with BSD-3-Clause; submissions under fundamentally incompatible licenses cannot be merged.

AI agents

If you are an AI coding agent, see AGENTS.md for detailed project conventions, commands, and architecture.