Skip to content

Consolidate repo guidance into AGENTS.md#31

Merged
xingyaoww merged 3 commits into
mainfrom
agents-md-consolidation
Jan 13, 2026
Merged

Consolidate repo guidance into AGENTS.md#31
xingyaoww merged 3 commits into
mainfrom
agents-md-consolidation

Conversation

@xingyaoww
Copy link
Copy Markdown
Member

Summary

  • Move content from .openhands/microagents/repo.md to AGENTS.md
  • Create symlink .openhands/skills/repo.md -> ../../AGENTS.md
  • Create symlink CONTRIBUTING.md -> AGENTS.md (if not existing)

This establishes AGENTS.md as the single source of truth for repository guidance, following the pattern from OpenHands/OpenHands-CLI#340

- Move content from .openhands/microagents/repo.md to AGENTS.md
- Create symlink .openhands/skills/repo.md -> ../../AGENTS.md
- Create symlink CONTRIBUTING.md -> AGENTS.md (if not existing)

This establishes AGENTS.md as the single source of truth for repository guidance.

Co-authored-by: openhands <openhands@all-hands.dev>
Copy link
Copy Markdown
Member

enyst commented Jan 12, 2026

Hi! I'm OpenHands (automated agent) helping with repo work.

Heads up: this PR introduces a legacy-path symlink .openhands/skills/repo.md -> ../../AGENTS.md.

We found that keeping this .openhands/skills/repo.md symlink causes the instructions to be loaded twice (AGENTS.md + the legacy repo skill path), which duplicates the guidance.

CONTRIBUTING.md -> AGENTS.md is fine; the duplication issue is specifically the .openhands/skills/repo.md symlink.

Example/fix: OpenHands/software-agent-sdk#1709 (removes the .openhands/skills/repo.md symlink).

Symlinks to AGENTS.md caused agent instructions to be loaded twice; replace with small pointer files.

Co-authored-by: openhands <openhands@all-hands.dev>
Copy link
Copy Markdown
Member Author

Addressed review feedback: removed legacy-path symlinks pointing to AGENTS.md (they caused instructions to be loaded twice when both AGENTS.md and the symlink target were loaded).

Replaced the symlinks with small pointer files:
- `CONTRIBUTING.md` (was symlink to `AGENTS.md`)
  • .openhands/skills/repo.md (was symlink to ../../AGENTS.md)

Remove legacy-path guidance files to avoid duplicated instructions; AGENTS.md is the single source of truth.

Co-authored-by: openhands <openhands@all-hands.dev>
Copy link
Copy Markdown
Member Author

Follow-up per review: removed legacy guidance files so only AGENTS.md remains.

Removed:
- `.openhands/skills/repo.md`
  • CONTRIBUTING.md

@xingyaoww xingyaoww marked this pull request as ready for review January 13, 2026 16:00
@xingyaoww xingyaoww merged commit db322c2 into main Jan 13, 2026
4 checks passed
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