Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (52 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

69 lines (52 loc) · 2.13 KB

Contributing to @decentralchain/node-api-js

Thank you for your interest in contributing!

Code of Conduct

By participating, you agree to abide by our Code of Conduct.

Prerequisites

  • Node.js >= 22 (24 recommended — see .node-version)
  • npm >= 10 (latest LTS recommended)

Setup

git clone https://github.com/Decentral-America/node-api-js.git
cd node-api-js
npm install

Scripts

Command Description
npm run build Build distribution files
npm test Run tests with Vitest
npm run test:watch Tests in watch mode
npm run test:coverage Tests with V8 coverage
npm run typecheck TypeScript type checking
npm run lint Biome lint
npm run lint:fix Biome lint with auto-fix
npm run format Format with Biome
npm run validate Full CI validation pipeline
npm run bulletproof Format + lint fix + typecheck + test
npm run bulletproof:check CI-safe: check format + lint + tc + test

Workflow

  1. Fork → branch from main (feat/my-feature)
  2. Make changes with tests
  3. npm run bulletproof
  4. Commit with Conventional Commits
  5. Push → open PR

Commit Convention

feat: add new method
fix: handle edge case
docs: update API reference
chore: bump dependencies
test: add coverage for X
refactor: simplify implementation

Standards

  • Strict mode — all TypeScript strict flags enabled
  • Biome — auto-formatting on commit
  • Coverage — thresholds enforced
  • Immutable — operations return new instances where applicable

PR Checklist

  • Tests added/updated
  • npm run bulletproof passes
  • Documentation updated if needed
  • Commit messages follow conventional commits