Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (42 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

62 lines (42 loc) · 1.64 KB
Raw

Contributing

Thank you for your interest in contributing to Archon!

Getting Started

  1. Fork the repository
  2. Clone your fork
  3. Install dependencies: bun install
  4. Copy .env.example to .env and configure
  5. Start development: bun run dev

Development Workflow

Code Quality

Before submitting a PR, ensure:

bun run check:bundled  # Bundled defaults are up to date (see note below)
bun run type-check     # TypeScript types
bun run lint           # ESLint
bun run format         # Prettier
bun run test           # All tests (per-package isolation)

# Or run the full validation suite:
bun run validate

Bundled defaults: If you added, removed, or edited a file under .archon/commands/defaults/ or .archon/workflows/defaults/, run bun run generate:bundled to refresh the embedded bundle before committing.

Important: Use bun run test (not bun test from the repo root) to avoid mock pollution across packages.

Commit Messages

  • Use present tense ("Add feature" not "Added feature")
  • Keep the first line under 72 characters
  • Reference issues when applicable

Pull Requests

  1. Create a feature branch from dev
  2. Make your changes
  3. Ensure all checks pass
  4. Submit a PR with a clear description

Code Style

  • TypeScript strict mode is enforced
  • All functions require explicit return types
  • No any types without justification
  • Follow existing patterns in the codebase

Architecture

See CLAUDE.md for detailed architecture documentation.

Questions?

Open an issue or start a discussion.