AGENTS.md

1# Repository Guidelines
2 
3This guide helps contributors work effectively in the Schedule I Developer Environment Utility repository (WinUI3 + MVVM on .NET 8).
4 
5## Project Structure & Module Organization
6- `App.xaml`, `MainWindow.xaml`: Application entry/view. Code-behind in `*.xaml.cs`.
7- `ViewModels/`: MVVM logic (e.g., `MainWindowViewModel`).
8- `Services/`: Core services (`SteamService`, `ConfigurationService`, `FileLoggingService`).
9- `Models/`: Data contracts (`DevEnvironmentConfig`, `SteamGameInfo`, `BranchInfo`).
10- `Assets/`: App icons and splash assets used by the package manifest.
11- `Properties/PublishProfiles/`: Packaging profiles (`win-x86`, `win-x64`, `win-arm64`).
12- `memories/`: Change logs and significant updates.
13 - Managed path layout: `<ManagedEnv>/branches/<branch>`, `logs/`, `temp/`.
14 - Config path: `%USERPROFILE%/AppData/LocalLow/TVGS/Development Environment Manager/config.json`.
15 
16## Build, Test, and Development Commands
17- Restore: `dotnet restore`
18- Build solution: `dotnet build "Schedule I Developer Environment Utility.sln"`
19- Run (dev): `dotnet run --project "Schedule I Developer Environment Utility.csproj"`
20- Publish (profile): `dotnet publish -c Release -p:PublishProfile=Properties/PublishProfiles/win-x64.pubxml`
21- Publish (self-contained): `dotnet publish -c Release -r win-x64 --self-contained`
22 
23## Coding Style & Naming Conventions
24- C#/.NET: 4-space indent; Allman braces; nullable aware.
25- Names: PascalCase for types/methods; camelCase for locals/fields; `I`-prefix for interfaces; async methods end with `Async`.
26- MVVM: `*ViewModel` for view-models; avoid code-behind logic beyond UI wiring. Prefer DI via `App.xaml.cs` for services and `ILogger<T>`.
27- XAML: Bind via properties/commands; keep UI strings in XAML resources when practical.
28 - Theme: app-wide dark mode (`RequestedTheme="Dark"`), title bar styled via `ThemeService`.
29 
30## Testing Guidelines
31- No test project currently. Prefer xUnit when adding tests.
32- Layout: `Tests/ProjectName.Tests/` with mirrors of `Services/` and `Models/` units.
33- Focus: Service logic and Steam/file operations; UI by manual verification.
34- Run tests: `dotnet test`
35 
36## Commit & Pull Request Guidelines
37- Commits: Conventional Commits (e.g., `feat(services): add branch parsing`), imperative mood, scoped when helpful.
38- PRs: clear description, linked issues, screenshots/GIFs for UI changes, reproduction/validation steps, and update docs (`CLAUDE.md`, `AGENTS.md`) if architecture or behavior changes.
39 
40## Security & Configuration Tips
41- Do not commit secrets or local AppData artifacts. Use environment variables or user secrets for tokens/keys.
42- File ops should be cancellable and show progress; avoid logging PII. Steam App ID is handled in `SteamService`.
43 - Branch build IDs are stored per-branch in config; appmanifest copied to each branch folder on copy for drift checks.
44 
45## Documentation & Comments
46- Use XML comments for public APIs; summarize purpose, params, returns, exceptions.
47- Document complex logic inline with comments.
48- After significant changes, update AGENTS.MD and CLAUDE.md as needed.
49- Create a detailed and compressed new entry in memory.md for significant changes.
50 
51## External Commands & Tools
52- Use `dotnet` CLI for builds, tests, publishing.
53- Visual Studio or VS Code for development.
54