RFC, docs: Add AGENTS.md - #3821
Open
FBruzzesi wants to merge 4 commits into
Open
Conversation
13 tasks
12 tasks
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.
Description
We started to observe more a more PRs which are LLM generated. As mentioned in #3632, I would not oppose to having an
AGENTS.mdfile - this can point the agent to the checks it needs to run before finalizing its work.The alternative is having myself or other reviewers checking out the PR just to realize something as simple as pre-commit hooks were not installed (see #3816) or
make typingwas not run locally.Triggering CI for that is also a waste of resources which I would like to avoid. Consider this an additional protection layer before we do any review.
Tip
Using "Display the rich diff" will make your life much easier in reviewing this PR
What type of PR is this? (check all applicable)
Related issues