Contribution Overview

This section describes how to contribute to:

  • susee (this repository — a TypeScript library bundler)
  • The internal build modules that implement bundling, dependency analysis, compilation, file output, and tsconfig resolution

Choose your contribution path

Contribute to susee

Use this path when your change is in the main CLI/tooling package, the build pipeline, docs, or integration behavior.

Read next: Contributing to Susee

Contribute to core build internals

Use this path when your change belongs to the internal build pipeline under src/, such as:

  • src/bundler.ts — bundling wrapper
  • src/compiler/ — TypeScript compilation and compiler option resolution
  • src/config/ — config parsing, validation, and build option generation
  • src/cli/ — CLI dispatch, argument parsing, init scaffolding
  • src/helpers/ — file system and minify helpers

Read next: Contributing to Core Build Packages

Shared contribution principles

  • Keep changes focused and small.
  • Add tests for behavior changes.
  • Keep docs in sync with API/CLI changes.
  • Prefer backward-compatible updates unless a breaking change is planned and documented.
  • Use npm as the contributor package manager.
  • After cloning, install git hooks with npm run hooks:install when the repository provides this script.

Before opening a PR

Use the quality checklist: Pull Request Checklist