-
Notifications
You must be signed in to change notification settings - Fork 174
docs: add AGENTS.md guidance for generated files #454
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+38
−4
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # Repository Guide | ||
|
|
||
| This repository is mostly generated code. | ||
|
|
||
| Before editing or approving a PR, check the top of the file: | ||
|
|
||
| ```python | ||
| """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. | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| AGENTS.md |
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some
.genignorefiles may still contain this header. We should either remove the header from all.genignorefiles or adjust the workflow so that.genignoreshould be checked first: if a file is in.genignorebut has the header, it can still be edited.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed: Remove stale generated headers from owned SDK files