agentleFS
Sign inStart free
JetBrainsKnown publisherJetBrains/compose-multiplatform-core/navigation3/AGENTS.md

compose-multiplatform-core / navigation3

AGENTS.md674 starsChanged 47 days agoApache-2.0View on GitHub

- When modifying any .kt file, format it via the following command: ./gradlew :ktCheckFile --format --file <file>. If more than one file needs formatting, continue adding --file <next-file> to the command. - When a public API is changed or when asked to update the public API files, execute: ./gradlew <project>:updateApi, the projects and their root paths can be found in settings.gradle. - When moving files, use git mv to keep version control history. - Do not make a git commit…

We split this AGENTS.md into the rules it gives an agent

7 rules. About 0 are common, 5 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    When modifying any .kt file, format it via the following command: ./gradlew :ktCheckFile --format --file <file>.

    line 5
  2. Very specific:

    When a public API is changed or when asked to update the public API files, execute: ./gradlew <project>:updateApi, the projects and their …

    line 8
  3. Distinctive:

    When moving files, use git mv to keep version control history.

    line 11
  4. Distinctive:

    Do not make a git commit unless specifically requested.

    line 12
  5. Distinctive:

    Language Conversion: When migrating files, convert them from Java to idiomatic Kotlin.

    line 16
  6. Distinctive:

    Assertion Library: When migrating or writing new tests, replace Hamcrest assertions with Kruth.

    line 17
  7. Distinctive:

    Kotlin Idioms: Prefer modern Kotlin idioms for readability.

    line 19

≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Project: Navigation3

General Instructions:

  • When modifying any .kt file, format it via the following command: ./gradlew :ktCheckFile --format --file <file>. If more than one file needs formatting, continue adding --file <next-file> to the command.
  • When a public API is changed or when asked to update the public API files, execute: ./gradlew <project>:updateApi, the projects and their root paths can be found in settings.gradle.
  • When moving files, use git mv to keep version control history.
  • Do not make a git commit unless specifically requested.

Development Workflow & Refactoring:

  • Language Conversion: When migrating files, convert them from Java to idiomatic Kotlin.
  • Assertion Library: When migrating or writing new tests, replace Hamcrest assertions with Kruth.
  • Kotlin Idioms: Prefer modern Kotlin idioms for readability.

Description of sub-projects:

  • navigation3-runtime: Contains the runtime Navigation3 APIs.
  • navigation3-compose: Contains the Compose integration for Navigation3.
  • navigation3-ui: Contains the UI integration for Navigation3.

Documentation links:

Download now (ZIP)

  • Other versions1 project uses a version of this.

    Word for word · 1

    1. androidx/androidx★ 6.1k100% same

    Edited · 0

    None found.

    Wrote their own version · 0

    None found.

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 28,693 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository4 other files it gives its agents.

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free