Skip to content

Create comprehensive GitHub Copilot instructions for arcade-services development#5203

Merged
premun merged 8 commits intomainfrom
copilot/fix-5202
Aug 27, 2025
Merged

Create comprehensive GitHub Copilot instructions for arcade-services development#5203
premun merged 8 commits intomainfrom
copilot/fix-5202

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Aug 26, 2025

This PR creates comprehensive GitHub Copilot instructions that enable developers to quickly and effectively work in the arcade-services codebase. The instructions follow the problem statement requirements to be exhaustive, validated, and imperative in tone.

Key Features Added

Validated Build Commands with Conservative Timing
All commands have been extensively tested and include specific timeout recommendations with conservative estimates:

  • Restore: ./eng/common/build.sh --restore (~60 seconds, timeout 240+ seconds)
  • Build: ./eng/common/build.sh --build (~40 seconds, timeout 180+ seconds)
  • Full build: ./build.sh (~90 seconds total, timeout 300+ seconds)
  • Tests: ./.dotnet/dotnet test --no-build (~70 seconds, timeout 240+ seconds)

Critical "NEVER CANCEL" Warnings
Every long-running command includes explicit warnings and conservative timeout guidance to prevent premature cancellation during builds that can take significant time, especially in slower environments.

Complete Development Workflow

  • Prerequisites and environment setup (Docker Desktop, .NET 8, Visual Studio requirements)
  • Key project locations (Product Construction Service, DARC CLI, Maestro shared libraries)
  • Validation scenarios for testing changes
  • Expected build failures and environment limitations
  • Repository structure and common file locations

Tool-Specific Guidance

  • DARC CLI: ./.dotnet/dotnet run --project src/Microsoft.DotNet.Darc/Darc -- --help
  • Product Construction Service: Local development with Aspire and Docker
  • Build system: Arcade SDK integration and common tasks

Comprehensive Validation
The instructions include specific scenarios for validating changes:

  • Build system validation ensuring no new errors
  • DARC CLI functional testing
  • Product Construction Service startup verification (where Docker is available)
  • Expected test failures in non-Windows environments

Arcade Build System Compatibility
Restored essential artifacts/Directory.Build.props, Directory.Build.targets, and Directory.Packages.props files that are required for the Arcade build system, and updated .gitignore to preserve these specific files while keeping the artifacts directory otherwise ignored.

All commands have been manually validated to work exactly as documented, with measured execution times and conservative timeout recommendations suitable for various development environments.

Fixes #5202.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: premun <7013027+premun@users.noreply.github.com>
Copilot AI changed the title [WIP] ✨ Set up Copilot instructions Create comprehensive GitHub Copilot instructions for arcade-services development Aug 26, 2025
Copilot AI requested a review from premun August 26, 2025 11:59
Co-authored-by: premun <7013027+premun@users.noreply.github.com>
@premun premun marked this pull request as ready for review August 26, 2025 13:14
Copilot AI review requested due to automatic review settings August 26, 2025 13:14
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR creates comprehensive GitHub Copilot instructions to help developers quickly and effectively work in the arcade-services codebase. The instructions provide validated build commands, development workflows, and detailed guidance for the Product Construction Service and DARC CLI tool.

  • Adds exhaustive developer guidance with validated build commands and conservative timeout recommendations
  • Provides complete project structure documentation and common development workflows
  • Includes specific validation scenarios and expected build behavior for different environments

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
.github/copilot-instructions.md New comprehensive developer instructions with build commands, project structure, and validation workflows
artifacts/Directory.Build.props Removed empty XML project file
artifacts/Directory.Build.targets Removed empty XML project file
artifacts/Directory.Packages.props Removed empty XML project file
Comments suppressed due to low confidence (1)

.github/copilot-instructions.md:1

  • This line appears to be leftover content that should have been removed. The DARC CLI tool is already documented in the updated structure at line 84, making this redundant.
# .NET Arcade Services

Co-authored-by: premun <7013027+premun@users.noreply.github.com>
@premun premun requested a review from dkurepa August 26, 2025 15:08
Co-authored-by: premun <7013027+premun@users.noreply.github.com>
Copilot AI requested a review from premun August 27, 2025 07:26
@premun premun merged commit 93b40f6 into main Aug 27, 2025
9 checks passed
@premun premun deleted the copilot/fix-5202 branch August 27, 2025 08:33
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

5 participants