Skip to content

Add comprehensive GitHub Copilot development instructions for Arke.ARI - #87

Draft
seiggy with Copilot wants to merge 2 commits into
masterfrom
copilot/fix-86
Draft

Add comprehensive GitHub Copilot development instructions for Arke.ARI#87
seiggy with Copilot wants to merge 2 commits into
masterfrom
copilot/fix-86

Conversation

Copilot AI commented Aug 29, 2025

Copy link
Copy Markdown

This PR adds a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot coding agents with detailed guidance for working effectively in the Arke.ARI codebase.

What's Included

The instructions cover all essential development workflows:

  • Initial Setup & Build: Complete bootstrap sequence with validated commands and exact timing
  • Project Structure: Clear guidance on the main library, samples, async samples, and code generation components
  • Build Validation: Step-by-step validation processes with expected outcomes
  • Sample Applications: How to build and understand the various example projects
  • Known Limitations: Important constraints like Windows-only code generation requirements

Key Features

  • Exhaustively Validated Commands: Every command has been tested and timed to ensure accuracy
  • Proper Timeout Guidance: Includes specific timeout recommendations (60+ seconds for builds) with "NEVER CANCEL" warnings
  • Expected Warning Documentation: Clearly identifies non-blocking warnings (RestSharp vulnerability, .NET 7 EOL)
  • Platform-Specific Guidance: Documents that code generation only works on Windows (.NET Framework 4.8)
  • No-Test Reality: Acknowledges that no unit tests exist in the repository

Validation Results

All commands were tested on Linux/Ubuntu with .NET 8:

  • dotnet restore: 2 seconds (with expected warnings)
  • dotnet build --configuration Release --no-restore: 2 seconds
  • dotnet test: 1 second (no tests exist)
  • Sample builds: 2 seconds each
  • NuGet package generation: ✅ Confirmed working

The instructions follow the imperative tone requirement ("Run this command", "Do not do this") and provide comprehensive guidance that enables any developer to quickly become productive with the codebase.

Fixes #86.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

…mands and timing

Co-authored-by: seiggy <1055990+seiggy@users.noreply.github.com>
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Add comprehensive GitHub Copilot development instructions for Arke.ARI Aug 29, 2025
Copilot AI requested a review from seiggy August 29, 2025 17:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

✨ Set up Copilot instructions

2 participants