ehealthsolutions/element-x-ios
3
0
Fork 0
mirror of https://github.com/Novaloop-AG/element-x-ios.git synced 2026-11-04 19:44:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

added a comments section

Browse Source
This commit is contained in:
Mauro Romito
2026-06-05 11:27:11 +02:00
committed by Mauro
parent 181def226b
commit 7cd406a011
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+6
View File
@@ -14,6 +14,12 @@ PRs must meet these rules. Prefer Xcode MCP tools over terminal commands.
- Follow [Swift API Design Guidelines](https://www.swift.org/documentation/api-design-guidelines/) everywhere, including Rust SDK wrappers (e.g. `ID` not `Id`, `URL` not `Url`, `configuration` not `config` or `cfg`). - Follow [Swift API Design Guidelines](https://www.swift.org/documentation/api-design-guidelines/) everywhere, including Rust SDK wrappers (e.g. `ID` not `Id`, `URL` not `Url`, `configuration` not `config` or `cfg`).
- File headers defined in `IDETemplateMacros.plist`. - File headers defined in `IDETemplateMacros.plist`.
### Comments
- **Code should speak for itself** — documentation comments are fine, but don't add comments restating what clearly written code already says.
- **Do** comment when the code hides a trap, is hard or convoluted to follow, or a specific choice needs justifying.
- Keep comments concise — a single line where possible; only exceed it when really necessary.
### PII & Logging ### PII & Logging
- Default: `MXLog.info`; unexpected failures: `.error`; noisy dev logs: `.verbose`. `.failure`/`.debug` rarely used. - Default: `MXLog.info`; unexpected failures: `.error`; noisy dev logs: `.verbose`. `.failure`/`.debug` rarely used.