ai-dev-gallery copilot-instructions.md

AI Dev Gallery - GitHub Copilot Custom Instructions

Repository Overview

AI Dev Gallery is a WinUI 3 desktop application showcasing local AI capabilities for Windows developers. It features interactive samples powered by local AI models, and enables exporting standalone Visual Studio projects.

Tech Stack: C#, WinUI 3, Windows App SDK, ONNX Runtime, WinML, .NET 9.0

PR Review Focus Areas

Security

• Check for hardcoded secrets, API keys, or credentials
• Verify Limited Access Features (LAF) tokens are not committed
• Ensure model URLs point to trusted sources (HuggingFace, GitHub)
• Verify telemetry events don't log sensitive data (user paths, usernames)

Performance

• Ensure model inference runs on background threads (Task.Run)
• Verify proper disposal of InferenceSession and other resources
• Check for memory leaks in image processing code

Sample Implementation Standards

When reviewing PRs that add or modify samples:

1. Class Structure

   • Must inherit from BaseSamplePage
   • Must have [GallerySample] attribute with all required properties
   • Must override LoadModelAsync(SampleNavigationParameters) or LoadModelAsync(MultiModelSampleNavigationParameters)
   • Must register Unloaded event handler for cleanup

2. [GallerySample] Attribute Requirements

   • Name: Display name (required)
   • Model1Types: Array of supported model types (required)
   • Scenario: Must reference a ScenarioType from scenarios.json
   • Id: Unique GUID (required)
   • Icon: Segoe MDL2 glyph (required)
   • NugetPackageReferences: Array of needed packages
   • SharedCode: Array of SharedCodeEnum values if using shared utilities

3. Model Loading Pattern

   • Call sampleParams.NotifyCompletion() when initialization finishes
   • Use await sampleParams.GetIChatClientAsync() for language models
   • Use sampleParams.WinMlSampleOptions for WinML EP configuration
   • Handle exceptions with ShowException(ex, message)

4. Resource Cleanup

   public MySample()
   {
       this.Unloaded += (s, e) => CleanUp();
       this.InitializeComponent();
   }
   
   private void CleanUp()
   {
       _session?.Dispose();
       _cts?.Cancel();
       _cts?.Dispose();
   }