docs: add AGENTS.md guidance for generated files#454
Merged
louis-sanna-dev merged 2 commits intomainfrom Mar 30, 2026
Merged
Conversation
louis-sanna-dev
changed the title
| """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. |
Contributor
There was a problem hiding this comment.
Some .genignore files may still contain this header. We should either remove the header from all .genignore files or adjust the workflow so that .genignore should be checked first: if a file is in .genignore but has the header, it can still be edited.
Contributor
Author
There was a problem hiding this comment.
Nelson-PROIA
approved these changes
Mar 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
DO NOT EDITheader and the relevant.genignorefilesCLAUDE.mdas a symlink so both agent entrypoints share the same guidanceWhy
We keep getting PRs that directly edit generated files. This gives reviewers and coding agents a short repo-local rule of thumb for what is hand-owned vs generated.