Contributing

Thanks for your interest in contributing to IC Reactor! This guide covers the development workflow, coding standards, and how to submit your changes.

Quickstart

Fork the repository and clone it:

git clone https://github.com/<your-username>/ic-reactor.git
cd ic-reactor
git remote add upstream https://github.com/B3Pay/ic-reactor.git

Install dependencies:
Terminal window
```
pnpm install
```

Build and test:

pnpm build
pnpm test
pnpm typecheck            # runs each packages/* typecheck script, tests included
pnpm format:check
pnpm check:ai-context

Formatting

We use Prettier for formatting. Format locally with:

pnpm format

You can check formatting without modifying files:

pnpm format:check

Husky + lint-staged will format staged files automatically on commit.

Running Tests

# Unit tests
pnpm test

# End-to-end tests
pnpm test-e2e

If you are adding a feature, include tests and documentation where applicable.

Before Opening a PR

CI also builds and type-checks every example app. Run pnpm typecheck:examples and pnpm build:examples locally if you touched anything under packages/ or examples/ — the examples are now built in CI, not merely type-checked, so a change that compiles against the workspace can still fail there.

Commits and Pull Requests

Use clear, descriptive commit messages.
Prefer small, focused PRs.
Include tests where applicable.
Add or update documentation for public API changes.

AI-Assisted Contributions

AI-assisted contributions are welcome, but contributors are responsible for correctness before opening a PR.

Prefer existing IC Reactor patterns over introducing new abstractions.
For React integrations, prefer createActorHooks(...) or query/mutation factories (createQuery, createMutation, etc.).
Validate generated or AI-written code with tests and examples whenever possible.
Update docs and examples when public API usage changes.