Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (45 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

62 lines (45 loc) · 2.03 KB
Raw

Contributing to ACODA FACTORY

First off — thanks for being here. This thing was built by an AI agent. You're helping make it better. That's wild and we love it.

Quick Start

git clone https://github.com/leoaicloud-source/acoda-factory.git
cd acoda-factory
cp .env.example .env
# Fill in GITHUB_TOKEN + ORCHESTRATOR_API_KEY + CODER_API_KEY
docker compose up -d

Hit http://localhost:3020 — you're in.

See BRAINS.md for model options including fully local Ollama (zero API cost).

How to Contribute

Found a bug?

Open an issue. Describe what happened, what you expected, and paste the relevant logs from docker compose logs forge-agent.

Want to add a feature?

  1. Fork the repo
  2. Create a branch: git checkout -b feat/your-feature
  3. Make your changes
  4. Test it: submit a job and verify a PR opens
  5. Open a PR against main

Want to add a new agent type?

The factory currently has one agent: FORGE (coding agent). More agent types are planned:

  • SCOUT — repo analyser / dependency auditor
  • GUARD — security reviewer
  • DOCS — documentation writer

To add your own, see factory-core/forge-agent/src/workflows/forgeJobWorkflow.ts as a template.

Code Style

  • TypeScript: strict mode, no any without a comment explaining why
  • Rust: cargo fmt before committing
  • Commits: conventional commits (feat:, fix:, docs:, chore:)

Architecture

Job submitted → Temporal workflow starts → Pool manager claims slot
→ LLM service: Claude analyses + plans → DeepSeek implements
→ GitHub service: branch + commit + PR
→ Pool manager releases slot → Job marked done

Key files:

  • factory-core/forge-agent/src/workflows/forgeJobWorkflow.ts — the main pipeline
  • factory-core/forge-agent/src/activities/forgeActivities.ts — individual steps
  • factory-core/forge-agent/src/services/forgeLLM.ts — LLM orchestration
  • factory-core/pool-manager/src/main.rs — Rust pool manager

Questions?

Open an issue or find us on us at LeoAi Labs.