Skip to content

Latest commit

 

History

History
80 lines (56 loc) · 2.4 KB

File metadata and controls

80 lines (56 loc) · 2.4 KB

retort — Gemini Instructions

Retort framework for multi-tool AI agent team orchestration, sync generation, and quality-gated workflows.

Project Context

  • Languages: javascript, yaml, markdown

  • Backend: node.js

  • ORM: none

  • Database: none

  • Messaging: none

  • Architecture: monolith

  • API Style: mixed

  • Default Branch: main

    • Phase: active

Coding Standards

  • Write minimal, focused diffs — change only what is necessary.
  • Maintain backwards compatibility; document breaking changes.
  • Every behavioral change must include tests.
  • Never commit secrets, API keys, or credentials. Use environment variables.
  • Prefer explicit error handling over silent failures.
  • Use the strongest type safety available for the language.
    • Follow conventional commit convention.
    • Branch strategy: github-flow.
    • Code review: required-pr.

Authentication & Authorization

Provider: custom-jwt, strategy: jwt-bearer. RBAC is enforced.

API Conventions

  • Versioning: url-segment
  • Pagination: cursor
  • Response format: envelope
  • Rate limiting is enabled

Testing

  • Unit: vitest

  • Integration: vitest

  • Coverage target: 80%

Always run the full test suite before creating a pull request.

Documentation

  • PRDs: docs/prd/

  • ADRs: docs/architecture/decisions/

  • API Spec: docs/api/

  • Technical Spec: docs/architecture/specs/

  • Brand Guide: .agentkit/spec/brand.yaml — AgentKit Forge (primary: #1976D2)

  • See AGENTS.md for universal agent instructions.

  • See QUALITY_GATES.md for quality gate definitions.

Code Review Guidelines

When reviewing code, focus on:

  1. Correctness — Does the code do what it claims?
  2. Security — Are there injection, auth, or data exposure risks?
  3. Testing — Are new behaviors covered by tests?
  4. Maintainability — Is the code readable and well-structured?
  5. Performance — Are there obvious performance concerns?
  6. Conventions — Does it follow established project patterns?