Add .github/agents.md: guidance for AI-assisted PRs (closes #6564) #6567
Conversation
.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." |
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.
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.
| --- | ||
|
|
||
| ## Code Standards for This Agent | ||
| | Type | Format | Example | |
There was a problem hiding this comment.
How about adding the link to the official Kotlin style guide: https://developer.android.com/kotlin/style-guide? I have whitelisted this domain for Copilot, and we can check if it works here.
.github/agents.md
Outdated
| @@ -0,0 +1,101 @@ | |||
|
|
|||
| --- | |||
| name: your-agent-name | |||
There was a problem hiding this comment.
Any specific name you suggest? Let's add a name that resonates with the community :)
.github/agents.md
Outdated
|
|
||
| --- | ||
| name: your-agent-name | ||
| description: [One-sentence description of what this agent does] |
There was a problem hiding this comment.
Could you please add the description too?
2 participants
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.