docs: Add AGENTS.md files for root and each module - #304
Open
NicolasBourdin88 with Copilot wants to merge 2 commits into
Open
docs: Add AGENTS.md files for root and each module#304NicolasBourdin88 with Copilot wants to merge 2 commits into
NicolasBourdin88 with Copilot wants to merge 2 commits into
Conversation
Agent-Logs-Url: https://github.com/Infomaniak/multiplatform-SwissTransfer/sessions/f3b1f57b-f18f-4670-93e0-8bc43e012ccb Co-authored-by: NicolasBourdin88 <167090505+NicolasBourdin88@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
NicolasBourdin88
May 22, 2026 09:02
View session
NicolasBourdin88
marked this pull request as ready for review
May 22, 2026 09:04
Contributor
There was a problem hiding this comment.
Pull request overview
Adds AGENTS.md documentation at the repository root and per-module level to provide a structured “map” of the codebase (modules, conventions, commands, and common gotchas) for AI agents and new contributors.
Changes:
- Added a top-level
AGENTS.mddescribing repo structure, build/test/publish flows, and cross-cutting conventions. - Added module-specific
AGENTS.mdfiles forSTCommon,STNetwork,STDatabase, andSTCoredocumenting responsibilities, layouts, and local norms. - Included “JIT index” command snippets (
rg/find) to speed up navigation.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| AGENTS.md | Top-level repository overview, commands, conventions, release and CI guidance. |
| STCommon/AGENTS.md | Documents shared contracts/public surface expectations for Swift via XCFramework export. |
| STNetwork/AGENTS.md | Documents Ktor client setup, repositories, error mapping, and URL helper strictness. |
| STDatabase/AGENTS.md | Documents Realm+Room migration, controllers/DAOs, schemas/migrations, and test strategy. |
| STCore/AGENTS.md | Documents SwissTransferInjection facade wiring, managers, and KMP patterns. |
Comments suppressed due to low confidence (1)
STCore/AGENTS.md:142
- This gotcha refers to
loadUser(userId), butSwissTransferInjectiondoesn’t expose that method. Consider updating this to point toaccountManager.loadUser(...)/logoutCurrentUser(...)(or whatever the intended public flow is) so the guidance matches the current API.
- The `userAgent` parameter on `SwissTransferInjection` is part of the public constructor signature — renaming or
removing it is a breaking change for all consumers.
- Don't bypass `loadUser(userId)` to swap accounts; the realm / database providers depend on it for per-user
isolation.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
NicolasBourdin88
force-pushed
the
copilot/add-agents-md-files
branch
from
May 22, 2026 09:27
93d8ba9 to
aec3925
Compare
|
FabianDevel
requested changes
May 22, 2026
| `infomaniak/.github/.github/workflows/semantic-commit.yml@v2`). Every commit message **and** PR title must match: | ||
|
|
||
| ``` | ||
| ^Merge .+|(^(feat|fix|chore|docs|style|refactor|perf|ci|test)(\(.+\))?: [A-Z0-9].+) |
Contributor
There was a problem hiding this comment.
Don't put the regex in static here, because it's not evolutive and defeat the purpose of the ./github repo
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



Adds
AGENTS.mdfiles to give AI agents (and new contributors) a fast, accurate map of the repo, inspired by the equivalents inInfomaniak/android-kMailandInfomaniak/android-SwissTransfer.Files added
AGENTS.md(root) — Repository overview, module dependency graph (STCore → STCommon/STNetwork/STDatabase), build/test/publish commands,buildToolsconvention plugins, release flow (./buildRelease,nmcpAggregation,Versions.mavenVersionName,Package.swift), semantic-commit/PR title regex, and cross-cutting Kotlin/KMP conventions.STCommon/AGENTS.md— Shared interfaces, models, exceptions, Matomo constants, utils. Highlights that it is the only module re-exported in theSTCoreXCFramework (appleExportedProjects), so its public surface = the iOS Swift surface.STNetwork/AGENTS.md—ApiClientProvider(Ktor + OkHttp/Darwin), v1/v2 repositories, typed exception mapping (UnauthorizedException,TooManyRequestException,UploadErrorsException, …),ApiUrlMatcherstrictness, kotlinx.serialization conventions.STDatabase/AGENTS.md— Parallel Realm (legacy) + Room/KSP (new) stacks, controllers vs DAOs,RealmMigrations, committedschemas/, and the Realm concurrency reason CI splitstestDebugUnitTest/iosSimulatorArm64Testinstead of runningallTests.STCore/AGENTS.md—SwissTransferInjectionfacade and lazy managers,loadUser(userId)lifecycle, mapper boundary,expect/actualpattern (EmailLanguageUtils.android.kt/.apple.kt), and rules for keeping iOS-visible types inSTCommon.Conventions captured
Each file follows the same structure: Summary → Tech Stack → Layout → Local Norms → Conventions → Commands → JIT Index (
rg/findrecipes) → Gotchas. Module files cross-link back to the root and to their siblings.No source or build configuration was changed.