Archon/CONTRIBUTING.md
Cole Medin ae346c2a67 feat: prepare for open-source migration to coleam00/Archon
- Replace all dynamous-community/remote-coding-agent references with coleam00/Archon
- Replace all ghcr.io/dynamous-community/remote-coding-agent with ghcr.io/coleam00/archon
- Change license from proprietary Dynamous to MIT
- Fix cd directory name in docs (remote-coding-agent → Archon)
- Remove hardcoded local paths from skills and docs
- Add Windows x64 binary to release pipeline (cross-compiled from Linux)
- Add --minify --bytecode flags to binary compilation
- Create PowerShell install script (scripts/install.ps1)
- Fix isBinaryBuild() detection for Bun 1.3.5+ (use import.meta.dir virtual FS check)
- Scaffold Astro Starlight docs site at website/ (Astro 6 + Starlight 0.38)
- Add deploy-docs.yml workflow for GitHub Pages
- Update test.yml branch triggers (develop → dev)
- Add install section with curl/PowerShell/Homebrew/Docker to README
- Add badges and archon.diy docs link to README
- Create SECURITY.md with vulnerability disclosure policy
- Update CONTRIBUTING.md for public audience
- Add website/ and eslint ignores for Astro-generated files

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-04 10:47:22 -05:00

1.4 KiB

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 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

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.