> ## Documentation Index
> Fetch the complete documentation index at: https://stars-components.js.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Contributing

> Develop packages and documentation in the Stars Components monorepo.

Contributions should start from `main` and stay focused on utilities that are broadly useful to Star Network projects.

## Set Up the Repository

```bash theme={"system"}
git clone https://github.com/wolfstar-project/stars-components.git
cd stars-components
corepack enable
pnpm install --frozen-lockfile
```

Node.js 24 matches CI, while packages support Node.js 20 and newer.

## Run the Quality Gates

Build before typechecking because cross-package type resolution uses generated declarations:

```bash theme={"system"}
pnpm lint
pnpm build
pnpm typecheck
pnpm test
```

Package changes need a changeset:

```bash theme={"system"}
pnpm changeset
```

Documentation-only changes can use an empty changeset.

## Work on the Documentation

```bash theme={"system"}
pnpm docs
```

The docs command regenerates the API reference from all public package entry points and starts VitePress. Package guides
include the package README content, so edit `packages/<name>/README.md` when the same guidance should appear on npm.

Verify a production documentation build with:

```bash theme={"system"}
pnpm docs-build
```

## Project Guidelines

* Keep additions useful across projects rather than tied to one bot.
* Preserve sharding compatibility.
* Prefer behavior-oriented APIs with predictable state.
* Follow the repository's Oxlint and Oxfmt configuration.
* Add tests for behavior changes and update package documentation when public APIs change.

See the complete [contributing guide](https://github.com/wolfstar-project/stars-components/blob/main/.github/CONTRIBUTING.md)
before opening a pull request.