Skip to content

draft generatic AGENTS.md template#128

Open
avertrees wants to merge 2 commits into
ai-guidelinesfrom
draft-agents
Open

draft generatic AGENTS.md template#128
avertrees wants to merge 2 commits into
ai-guidelinesfrom
draft-agents

Conversation

@avertrees

Copy link
Copy Markdown


## Project Overview

[One sentence: language/framework, key versions, what makes this repo architecturally non-standard]

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants