Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (25 loc) · 848 Bytes

CONTRIBUTING.md

File metadata and controls

36 lines (25 loc) · 848 Bytes
Raw

Contributing

Thank you for helping improve Dir Tree.

Development

Install dependencies, then run the core checks:

npm install
npm run typecheck
npm run test
npm run build
npm run pack:dry

Code standards

  • Keep the root src package headless
  • Do not import React, Vite, Next.js, UI libraries, analytics, or playground code from src
  • Keep comments in English
  • Add tests for public behavior before exporting new APIs
  • Prefer small domain modules over broad utility buckets

Public API changes

New public exports should include:

  • A stable name
  • Unit tests
  • README or API documentation
  • A package export if they belong to a subpath

Release checks

Before publishing, follow docs/release.md. The release checklist verifies the headless package boundary, installed package smoke tests, and playground build.