Skip to content

Contributing

Contributions are welcome! The full contributor guide lives in the repo alongside the code:

Quick dev loop

bash
# Rust build + unit tests
cargo build --release
cargo test --workspace

# Node integration tests against a freshly staged N-API addon
pnpm test:node

# Lint & format
cargo fmt --all -- --check
cargo clippy --workspace --all-targets -- -D warnings

Docs contributions

The docs site is VitePress, sources in docs/:

bash
pnpm install
pnpm docs:dev      # hot-reload on localhost:5173
pnpm docs:build    # production build
pnpm docs:preview  # preview built site

Docs deploy automatically as part of the release workflow; the standalone .github/workflows/docs.yml can also be run on demand (workflow_dispatch) to publish docs-only changes between releases.

Reporting issues

Please file issues on GitHub Issues with:

  • tsgo-strict version
  • Node version, OS, and architecture
  • Minimal reproducing tsconfig + file(s), if applicable
  • The full output of the failing run

Released under the Apache License 2.0.