Skip to content

AGENTS.md

Latest commit

 

History

History
37 lines (24 loc) · 1.12 KB

AGENTS.md

File metadata and controls

37 lines (24 loc) · 1.12 KB

Repository Guide

This repository is mostly generated code.

Before editing or approving a PR, check the top of the file:

"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""

If that marker is present, do not hand-edit the file. Changes should be made in the upstream source or generator inputs, then regenerated.

What We Own

The main hand-maintained surface is listed in .genignore.

At the repo root, that currently includes files such as:

  • pyproject.toml
  • examples/*
  • utils/*
  • src/mistralai/extra/*
  • pylintrc
  • scripts/prepare_readme.py

There are also package-specific ownership files:

  • packages/gcp/.genignore
  • packages/azure/.genignore

If a file is not listed in the relevant .genignore and it has the generated header, assume it should not be edited directly.

PR Review Rule Of Thumb

  • Prefer PRs that change hand-owned files listed in .genignore.
  • Be skeptical of direct edits to generated SDK files under src/, docs/, or packages/*/src/.
  • If a generated file changed, look for the corresponding source/config change that explains the regeneration.