Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (40 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

53 lines (40 loc) · 1.71 KB

Contributing to nodepod

Thanks for your interest in contributing!

Setup

git clone https://github.com/ScelarOrg/Nodepod.git
cd Nodepod
npm install

Development

npm run type-check    # TypeScript validation (must pass with 0 errors)
npm run build:lib     # Build ESM + CJS library bundles
npm run build:types   # Generate type declarations
npm run build:publish # Full publish build (lib + types)
npm test              # Run test suite
npm run test:watch    # Run tests in watch mode

Project Structure

  • src/ — All source code (TypeScript)
    • polyfills/ — Node.js built-in module implementations
    • shell/ — Bash-like shell interpreter
    • packages/ — npm package management
    • threading/ — Worker-based process model
    • sdk/ — Public SDK layer (Nodepod, NodepodFS, NodepodTerminal, NodepodProcess)
  • docs/ — Architecture documentation
  • static/ — Service Worker for HTTP interception

Pull Requests

  1. Fork the repo and create a branch from main
  2. Make your changes
  3. Ensure npm run type-check passes with 0 errors
  4. Ensure npm run build:lib succeeds
  5. Open a PR with a clear description of the change

Key Conventions

  • All polyfill files in src/polyfills/ are named to match their Node.js module (e.g., fs.ts, http.ts)
  • EventEmitter methods must use this._reg() (lazy init pattern) — never access this._registry directly
  • ESM-to-CJS replacement strings must include trailing semicolons
  • CORE_MODULES polyfills must never use async functions
  • The shell (src/shell/) uses Record<string, string> for env (not Map)

License

By contributing, you agree that your contributions will be licensed under the MIT + Commons Clause License.