Skip to content

chore: update AGENTS.md with correct Flutter version and test docs #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SunkenInTime wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: update AGENTS.md with correct Flutter version and test docs #56

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ A Flutter desktop app for creating interactive Valorant game strategies. See `RE

### Key caveats

- **FVM is required.** Flutter is pinned to `3.38.4` via `.fvmrc`. Always prefix Flutter/Dart commands with `fvm` (e.g. `fvm flutter run`, `fvm dart run`).
- **FVM is required.** Flutter is pinned to `3.41.1` via `.fvmrc`. Always prefix Flutter/Dart commands with `fvm` (e.g. `fvm flutter run`, `fvm dart run`).
- **`xdg-user-dirs` must be initialized.** The `path_provider` plugin needs XDG user directories. Run `sudo apt-get install -y xdg-user-dirs && xdg-user-dirs-update` if the app crashes with `MissingPlatformDirectoryException`.
- **Linux build deps.** `clang cmake ninja-build pkg-config libgtk-3-dev liblzma-dev libstdc++-14-dev` must be installed for Linux desktop builds.
- **Code generation.** After changing Hive models, Riverpod providers, or JSON-serializable classes, regenerate with: `fvm flutter pub run build_runner build --delete-conflicting-outputs`.
- **No automated tests exist** in this codebase. `flutter test` will find nothing.
- **Lint.** `fvm flutter analyze` — expect ~70 pre-existing warnings/infos (unused imports, deprecated APIs). No errors.
- **Tests.** `fvm flutter test` — 24 test files exist. Expect ~147 passes and ~6 pre-existing failures.
Copy link

Copilot AI Mar 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The exact test outcome counts ("~147 passes" / "~6 pre-existing failures") are likely to drift as tests are added/removed or flakes are fixed. Consider phrasing this more durably (e.g., "a large suite of tests exists; a few known failures remain") and/or listing the specific known failing tests so readers can quickly distinguish regressions from expected failures.

Suggested change
- **Tests.** `fvm flutter test` — 24 test files exist. Expect ~147 passes and ~6 pre-existing failures.
- **Tests.** `fvm flutter test` — a substantial automated test suite exists; expect most tests to pass, with a small number of known pre-existing failures that should be distinguished from new regressions.

Copilot uses AI. Check for mistakes.
- **Lint.** `fvm flutter analyze` — expect a handful of pre-existing info-level diagnostics (`prefer_const_constructors`). No errors.
- **Build.** `fvm flutter build linux --debug` produces the binary at `build/linux/x64/debug/bundle/icarus`.
Loading