feat: add agents.md with compiled best practices (MVP)#485
Conversation
ssbarnea
changed the title
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
This comment was marked as outdated.
This comment was marked as outdated.
ssbarnea
requested review from
Qalthos,
anusshukla,
cidrblock and
shatakshiiii
There was a problem hiding this comment.
Pull Request Overview
This PR adds a comprehensive Ansible coding guidelines document for AI agents. The primary purpose is to create a centralized resource containing best practices for AI agents working with Ansible code, ensuring consistency and quality.
- Creates a detailed guidelines document with best practices for Ansible development workflows, coding standards, and project structures
- Adds supporting instructions for AI agents to generate and maintain the guidelines document
- Updates configuration files to support the new documentation
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| tools/AGENTS.md | Instructions for AI agents to analyze and update the main guidelines document |
| docs/agents.md | Comprehensive Ansible coding guidelines covering workflows, standards, and best practices |
| cspell.config.yaml | Adds technical terms to spell check ignore list |
| AGENTS.md | Updates testing instructions to use tox instead of pre-commit |
| .config/dictionary.txt | Adds FQCN-related terms to dictionary |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
cidrblock
left a comment
cidrblock
left a comment
There was a problem hiding this comment.
I'm approving b/c a think it is a great start. Let's see if we can get some reviews from outside the team as well.
github-project-automation
bot
moved this from In Progress
to Review
in 🧰 devtools project board
ssbarnea
changed the title
|
I think this document is a great start, and we can continue to iterate. |
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
github-project-automation
bot
moved this from Review
to Done
in 🧰 devtools project board
This is an initial MVP agents.md file and the main goal while reviewing it is to spot anything that we do not want to recommend. Missing practices is ok as we can always improve it.
Fixes: AAP-55525