draft generatic AGENTS.md template#128
Open
avertrees wants to merge 2 commits into
Open
Conversation
alea12
reviewed
Jun 22, 2026
|
|
||
| ## Project Overview | ||
|
|
||
| [One sentence: language/framework, key versions, what makes this repo architecturally non-standard] |
Member
There was a problem hiding this comment.
Idea: add a prompt that we could use to populate this section using agents. Something like:
You are an expert software developer performing a codebase audit.
Your task: populate the "Project Overview" section of `AGENTS.md`.
Browse the repository and document:
- Primary language(s) and frameworks
- Full tech stack (runtime, build tools, test frameworks, infrastructure, etc.)
- Architectural patterns or notable conventions
- Anything else that would help an agentic model navigate, modify, or extend this codebase effectively
Be specific and concise. Prefer facts over generalities.
| @@ -0,0 +1,66 @@ | |||
| # AGENTS.md | |||
Member
There was a problem hiding this comment.
Maybe we could instruct agents to reference this repo (engineering-general) for general guidelines, with each project being able to add override configurations on top
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
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.
inspired by https://www.augmentcode.com/guides/how-to-build-agents-md