Skip to content

Conversation

@lev-n
Copy link

@lev-n lev-n commented Jan 5, 2026

Repository guidelines for AI agents

AGENTS.md is a structured context file for AI coding assistants (like GitHub Copilot, Cursor, etc.) that provides quick-reference project information in a concise, machine-readable format.


When to Update AGENTS.md

The file should be updated when:

  1. New build flavors are added
  2. Module structure changes significantly
  3. Build commands change (e.g., Gradle task names)
  4. Coding conventions evolve (e.g., new ktlint rules)
  5. Testing infrastructure changes (e.g., new test directories)
  6. Branch strategy changes (e.g., moving from dev to main)

Comparison with Other Documentation

File Target Audience Length Style Update Frequency
README.md General public 19 lines Brief overview Rarely
CONTRIBUTING.md Human contributors 204 lines Detailed, conversational Occasionally
AGENTS.md AI assistants 37 lines Structured, concise When project structure changes
Wiki End users & contributors Extensive Tutorial-style Frequently

@lev-n lev-n changed the base branch from master to dev January 5, 2026 08:54
@lev-n lev-n changed the title agents md Repository guidelines for AI agents Jan 5, 2026
@sonarqubecloud
Copy link

sonarqubecloud bot commented Jan 5, 2026

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.

1 participant