Add .github/agents.md: guidance for AI-assisted PRs (closes #6564) #6567
+101
−0
Conversation
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
.github/agents.md
Outdated
| - Provide tests or sample inputs if relevant. | ||
|
|
||
| Examples of good prompts | ||
| - "Add a .github/agents.md file that explains how to ask Copilot to create small PRs with: summary, motivation, implementation, test steps, and issue reference." |
Collaborator
There was a problem hiding this comment.
Is this from the blog? Sorry if the intent of the issue wasn't clear - we need agents.md file and the blog has some great examples that we can read to write a good agents.md file. We can mention that this is an Android project in Kotlin, provide commands for the testing agent and so on.
Author
There was a problem hiding this comment.
Thanks! I used the blog only as inspiration — this draft is my own. I’ll revise agents.md to be more repo-specific: mention it’s a Kotlin/Android project, add the test/build commands, and include clearer guidance for the testing agent. I’ll update the PR soon.
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 (required)
Fixes #6564
What changes did you make and why?
Summary
Adds .github/agents.md with guidance for AI/code-generation and human contributors.
Motivation
Provide clear, consistent guidance so generated PRs are higher quality and easier for maintainers to review.
Implementation
New .github/agents.md file; no code changes.
Tests performed (required)
Review the .github/agents.md content on GitHub.
CI should run; since no code changes, CI should pass quickly.
I have read CONTRIBUTING.md.