yilsem/aiturk-mobil
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 6 Wiki Activity

docs: sync AGENTS.md, README.md, and CONTRIBUTING.md with current codebase (#644)

Browse Source 
* docs: update AGENTS.md, README.md, and CONTRIBUTING.md

Sync all three docs with current codebase state:
Kotlin 2.4.10, Kotlinx Serialization, 28 screens,
6 theme presets, CI instrumented-tests job, color guard.

* docs: missed control
This commit is contained in:
M57
2026-07-20 18:27:16 +03:00
committed by GitHub
parent e18b25d065
commit 86c780c10b
3 changed files with 100 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+10 -1
View File
@@ -68,6 +68,13 @@ We enforce Kotlin coding conventions and Jetpack Compose best practices.
### Compose Guidelines
- Standard screen structures must use `HermesScaffold` rather than raw Material3 `Scaffold`.
- Composable parameters must follow the standard order: `modifier` first, then event callbacks, and finally children content.
- Do **not** apply `paddingValues` on inner content inside `HermesScaffold` — the scaffold already handles top bar padding. See `AGENTS.md` for the full breakdown of this recurring bug.
- Every data screen must implement `LoadingState`, `ErrorState`, and `EmptyState` branches in its `when { }` block.
### Color Usage
- **No hardcoded `Color(0x...)` literals** outside `theme/`, `*Preview.kt`, and auth screens. A Gradle task (`checkColorLiterals`) enforces this in CI.
- Use `MaterialTheme.colorScheme.<token>` or `LocalHermesStatusColors.current.<semantic>` instead.
- `Color.Transparent` and `Color.Unspecified` are allowed.
---
@@ -77,7 +84,9 @@ Before submitting your PR, please verify:
- [ ] Your branch is up-to-date with `main`.
- [ ] Local build and `ktlint` checks pass successfully.
- [ ] `checkColorLiterals` passes (no hardcoded Color literals outside theme/).
- [ ] No unused imports, unused parameters, or dead code.
- [ ] Every `Image` and `Icon` element has a descriptive `contentDescription` for accessibility.
- [ ] New components match the UI/UX style of similar existing screens.
- [ ] New screens use `HermesScaffold` and implement Loading/Error/Empty states.
- [ ] New components match the UI/UX style of similar existing screens (28+ screens for reference).
- [ ] Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/) and are atomic (subject + ≤2 lines body).