Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.73 KB

File metadata and controls

52 lines (34 loc) · 1.73 KB

AGENTS.md

Instructions for AI agents working on this repository.

Architecture

See ARCHITECTURE.md for an overview of the turbo run command architecture.

Keeping Documentation Up to Date

When making changes to the codebase, check if the following docs need updates:

  • ARCHITECTURE.md - Update when changing core turbo run components:

    • Run builder, package graph, task graph/engine
    • Task visitor, caching system, task hashing
    • Run tracking and summary generation
    • Any files in crates/turborepo-lib/src/run/, crates/turborepo-lib/src/engine/, crates/turborepo-lib/src/task_graph/, or crates/turborepo-cache/
  • CONTRIBUTING.md - Update when changing:

    • Build process or development setup
    • Testing procedures or requirements
    • Project structure or tooling
  • This file (AGENTS.md) - Update when changing:

    • PR requirements or CI workflows
    • Repository conventions or policies

Pull Request Guidelines

Always run pre-commit/pre-push hooks

  • You are not allowed to use --no-verify when making a commit or push.
  • If you do not have dependencies available, you can download them with pnpm install --frozen-lockfile.

PR Title Format

PR titles must follow Conventional Commits. See .github/workflows/lint-pr-title.yml for the enforced constraints.

Format: <type>: <Description>

Key rules:

  • Description must start with an uppercase letter
  • Scopes are not allowed

Examples:

feat: Add new cache configuration option
fix: Resolve race condition in task scheduling
docs: Update installation instructions