Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
106 lines (73 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

106 lines (73 loc) · 2.71 KB
Raw

Contributing

Thanks for your interest in contributing to @runloop/remote-agents-sdk.

Prerequisites

  • Node.js >= 22
  • Bun (package manager and task runner)

Getting Started

git clone git@github.com:runloopai/remote-agents-sdk.git
cd remote-agents-sdk
bun install
bun run build

Repository Structure

This is a Bun workspaces monorepo:

  • sdk/ — The published @runloop/remote-agents-sdk package. All SDK source lives in sdk/src/.
  • examples/ — Example applications that consume the SDK. These are private packages and are not published.

Development Workflow

Working on the SDK

# Build the SDK
bun run build

# Watch mode (rebuilds on changes)
bun run --filter '@runloop/remote-agents-sdk' dev

# Run tests
bun run test

# Run tests in watch mode
bun run --filter '@runloop/remote-agents-sdk' test:watch

# Lint and format check
bun run check

# Auto-fix lint and formatting issues
bun run --filter '@runloop/remote-agents-sdk' check:fix

Working on examples

Each example app has its own dev server:

bun run --filter '@runloop/example-combined-app' dev # Combined (Claude + ACP) example

Commit Conventions

This project uses Conventional Commits and Release Please for automated versioning and changelog generation.

Do not manually bump versions. Release Please handles this automatically based on commit messages merged to main.

Commit message format

<type>(<scope>): <description>

[optional body]

Common types:

Type Description Version bump
feat A new feature Minor
fix A bug fix Patch
docs Documentation changes None
refactor Code change that neither fixes a bug nor adds a feature None
test Adding or updating tests None
chore Maintenance tasks None

Breaking changes: add ! after the type (e.g., feat!: remove deprecated API) or include BREAKING CHANGE: in the commit body. This triggers a major version bump.

Examples

feat(acp): add session reconnection support
fix(claude): handle transport disconnect during read loop
docs: update README with Claude module examples
test(acp): add unit tests for session update type guards

Pull Requests

  1. Create a feature branch from main.
  2. Make your changes and ensure all checks pass: 
    bun run check   # lint + format
bun run build   # type check
bun run test    # tests
  3. Write a clear PR description explaining what changed and why.
  4. Request a review.

CI will automatically run lint, build, and test checks on your PR.