Skip to content

Add AGENTS.md to repo-smith#20

Open
VikramGoyal23 wants to merge 3 commits into
git-mastery:mainfrom
VikramGoyal23:agents
Open

Add AGENTS.md to repo-smith#20
VikramGoyal23 wants to merge 3 commits into
git-mastery:mainfrom
VikramGoyal23:agents

Conversation

@VikramGoyal23

Copy link
Copy Markdown
Contributor

AGENTS.md provides instructions for AI coding agents working with the repo-smith codebase.

@jovnc

jovnc commented Jan 26, 2026

Copy link
Copy Markdown
Contributor

@VikramGoyal23 Is there a reason for putting it in copilot-instructions.md instead of in Agents.md?

Ideally we would want our instructions to be AI-agnostic and not provide context for github copilot only right?

@VikramGoyal23
VikramGoyal23 marked this pull request as draft January 26, 2026 13:00
@VikramGoyal23

Copy link
Copy Markdown
Contributor Author

@jovnc Forgive me, this draft is incomplete. Chat instructions are meant to be added in the copilot-instructions.md file. I am still working on adding support for multiple agents, I have marked this PR as a draft.

@jovnc

jovnc commented Jan 30, 2026

Copy link
Copy Markdown
Contributor

@VikramGoyal23 Let's try to finish this by end of week

@VikramGoyal23
VikramGoyal23 marked this pull request as ready for review February 1, 2026 16:09
@VikramGoyal23
VikramGoyal23 requested a review from jovnc February 1, 2026 16:09
@VikramGoyal23

Copy link
Copy Markdown
Contributor Author

@jovnc The file is ready for review.

@jovnc jovnc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Other than that LGTM, content-wise it's ok

Comment thread AGENTS.md

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This AGENTS.md file would work if working in multi-agent environment
eg. core orchestrator that spawns sub-agents and delegates tasks to them

However, I'm not sure if it is supported by most agentic tools currently, eg. github copilot does not support this. This seems more suitable for tools like Claude Code.

AGENTS.md being a universal context should be independent of this, hence maybe it's better to phrase it another way than specifying different agents, eg. can use SKILL.md instead, or simply just state the responsibility of the agent when performing X task

@VikramGoyal23

Copy link
Copy Markdown
Contributor Author

@jovnc What do you think of this small extra comment? Also, I am slightly torn on the state of the file, since I feel as if this amount of context would be too much for a typical agent to have out the gate.

@SAN-MUYUN SAN-MUYUN left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Other than the agent orchestration that you are trying to achieve here, the rest LGTM

Comment thread AGENTS.md
- **Imports**: Group in order: stdlib → third-party → local. Use absolute imports from `repo_smith`
- **Dataclasses**: Prefer `@dataclass` for simple data containers

Below is a list of agents you may be asked to act as. Check the relevant section for further context on how that particular agent would act.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This is a very good attempt, but let's not do Agent orchestration in this Agent.md. Agent orchestration should only be carried out when developer/contributor is fully aware of what each subagent is trying to do. This will cause huge amount of token to be used, and token usage by each subagent cannot be tracked easily.

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.

3 participants