Skip to content

Update AGENTS.md for view-model architecture #36

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

Merged
danielchalmers merged 1 commit into from
Jun 18, 2026
Merged

Update AGENTS.md for view-model architecture #36

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
14 changes: 12 additions & 2 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,18 @@ These instructions apply to Codex and other coding agents working in this repo.

## Scope
- This repo is the **Sentry Replay** WPF desktop app (XAML + C#).
- Preserve existing MVVM patterns, bindings, and XAML style conventions unless asked to refactor.
- Media playback uses Flyleaf; logging uses `Serilog`.

## Architecture
- **`SentryReplay.Data`** — pure domain logic: TeslaCam storage models (`Cam*`) and playback types (`ClipPlaylist`, `ClipTimeline`, `ICameraPlayer`, …). It has no WPF, Flyleaf, or UI dependencies — keep it that way so this logic stays unit-testable.
- **`SentryReplay`** — the WPF app: views (`*.xaml` + thin `*.xaml.cs`), view-models (`*ViewModel.cs`), and services (`Services/`).
- Keep view-models free of WPF control references. A view-model exposes state and commands; the view binds to them. Anything that must touch a named control, the dispatcher, or the visual tree (focus, control re-parenting, window lifecycle) belongs in the view's code-behind, not the view-model.

## Where new code goes
- New feature logic, state, and commands go in a **view-model**, not in window/view code-behind. Code-behind is for view-only plumbing.
- Don't reach for the largest existing file by default. If a view-model is growing unwieldy, split it by feature rather than letting one file own everything.
- Keep code-behind small: if a `*.xaml.cs` is pushing past ~150 lines or holds non-view logic, that logic probably belongs in a view-model.

## XAML
- Keep XAML readable: group related properties and follow `Settings.XamlStyler`.
- Use existing resources/styles before adding new ones.
Expand All @@ -15,7 +24,7 @@ These instructions apply to Codex and other coding agents working in this repo.

## C#
- Follow `.editorconfig` naming and formatting rules.
- Prefer `ObservableProperty`/`RelayCommand` (CommunityToolkit.Mvvm) where already used.
- Use `ObservableProperty`/`RelayCommand` (CommunityToolkit.Mvvm) for view-model state and commands.

## WPF-specific considerations
- Be mindful of dispatcher usage when touching UI from background tasks.
Expand All @@ -25,4 +34,5 @@ These instructions apply to Codex and other coding agents working in this repo.
## Testing/Validation
- Always run `dotnet format`.
- Tests live in `SentryReplay.Tests` and use xUnit/Shouldly.
- Add tests for new view-model and domain logic — view-models are plain objects that can be constructed directly in tests (see `MainWindowViewModelTests`).
- If you change UI behavior, mention how to verify it (e.g., which view to open, what to click).