Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (49 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

71 lines (49 loc) · 2.01 KB
Raw

Contributing to AllAgents

Thanks for contributing.

The One Rule

Understand your change. If you can't explain what your code does, why it belongs in AllAgents, and how it affects existing behavior, don't submit it yet.

Using AI tools is fine. Shipping code you don't understand is not.

Before You Build

For non-trivial features or behavior changes, open an issue first and wait for maintainer alignment.

Development Setup

bun install
bun run build
bun test

Run CLI changes from source during development:

bun run dev workspace init test-ws
bun run dev update

Before Submitting a PR

  • PR explains what changed and why
  • Tests are updated when relevant
  • No unrelated refactors in the same PR
  • Run focused local checks while developing and the relevant broad checks before pushing
  • Manual E2E test: build the CLI (bun run build) and run against a temp workspace

GitHub Actions is the authoritative broad quality gate. It runs build, typecheck, lint, and the full test suite as separate checks on pull requests and main. Repository maintainers should configure the Build, Typecheck, Lint, and Test checks as required in the main branch protection rules after this workflow lands. You can run the same checks locally when needed:

bun run build
bun run typecheck
bun run lint
bun run test

Older clones may still have the previously generated prek pre-push hook. If a push still invokes prek, inspect .git/hooks/pre-push and remove it only when it is the generated prek hook; preserve any custom hook content.

Workflow

  • Branch from main
  • Use conventional commits: type(scope): description
  • Open a PR (draft is fine)
  • Squash merge when approved

Publishing

Never run npm publish directly. Use the two-step workflow:

  1. bun run publish:next — publishes to the next tag
  2. bun run promote:latest — promotes next to latest after testing

Architecture

See CLAUDE.md for architecture notes, coding standards, and AI agent guidelines.