Skip to content

Conversation

Copilot
Copy link

@Copilot Copilot AI commented Sep 17, 2025

GitHub Copilot Instructions for OpenTelemetry .NET - Complete ✅

Successfully created comprehensive GitHub Copilot instructions for the OpenTelemetry .NET repository at .github/copilot-instructions.md.

✅ Key Features Implemented:

  • Complete Environment Setup - Instructions that dynamically reference .NET SDK version from global.json
  • Comprehensive Build Commands - All key build, test, and validation commands with timing expectations
  • Project Structure Navigation - Clear mapping of all major directories and their purposes
  • Validation Scenarios - Practical examples for testing changes with console and ASP.NET Core apps
  • CI/CD Integration - Commands that align with repository workflows (dotnet format, markdownlint)
  • Known Issues Documentation - Platform-specific notes and build considerations
  • Public API Guidelines - Critical guidance for maintaining API stability

🚀 Instructions Include:

  • Imperative tone throughout with clear "Do this" commands
  • Explicit timing warnings with "NEVER CANCEL" guidance for long-running operations
  • Complete directory structure mapping for quick navigation
  • Working validation workflows from basic setup to full development cycles
  • Platform-specific considerations for Windows vs Linux/macOS development
  • Public API safety guidelines to prevent breaking changes
  • Dynamic SDK version handling - References global.json instead of hardcoded versions

The instructions provide comprehensive guidance for GitHub Copilot agents to work effectively in this codebase, covering everything from initial setup to advanced development workflows including:

  • Environment setup with dynamic .NET SDK version detection from global.json
  • Build and test commands with appropriate timeouts
  • Project navigation for src/, test/, docs/, examples/, and build/ directories
  • Validation using example applications
  • CI/CD integration matching repository workflows
  • Public API stability guidelines for this production library

Updated to use dynamic .NET SDK version from global.json instead of hardcoded version to accommodate frequent Dependabot updates.

Fixes #6501.


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

@rajkumar-rangaraj
Copy link
Contributor

@copilot try again

…repository

Co-authored-by: rajkumar-rangaraj <9479006+rajkumar-rangaraj@users.noreply.github.com>
Copy link
Author

Copilot AI commented Sep 17, 2025

@copilot try again

I've now created the comprehensive GitHub Copilot instructions file at .github/copilot-instructions.md. The instructions include:

  • Complete environment setup with .NET SDK 9.0.304 requirements
  • Comprehensive build and test commands with timing expectations
  • Project structure navigation guide
  • Validation scenarios using example applications
  • CI/CD integration guidance
  • Public API safety guidelines

The file provides imperative, actionable guidance for working effectively in this OpenTelemetry .NET codebase. Commit: 53a8ef8

@Copilot Copilot AI changed the title [WIP] ✨ Set up Copilot instructions ✨ Add comprehensive GitHub Copilot instructions for OpenTelemetry .NET Sep 17, 2025
@rajkumar-rangaraj
Copy link
Contributor

@copilot The .NET SDK gets frequently updated through Dependabot requests. You cannot add a dependency to a specific version; instead, it should pick the version from global.json.

…al.json

Co-authored-by: rajkumar-rangaraj <9479006+rajkumar-rangaraj@users.noreply.github.com>
Copy link
Author

Copilot AI commented Sep 17, 2025

@copilot The .NET SDK gets frequently updated through Dependabot requests. You cannot add a dependency to a specific version; instead, it should pick the version from global.json.

Updated the instructions to reference the .NET SDK version dynamically from global.json instead of hardcoding a specific version. The instructions now:

  • Use cat global.json to check the required version
  • Reference "the .NET SDK version specified in global.json" throughout
  • Suggest installing the latest stable SDK that will work with global.json

This approach accommodates frequent Dependabot updates to the SDK version. Commit: 84cf30e

Copy link
Contributor

This PR was marked stale due to lack of activity and will be closed in 7 days. Commenting or pushing will instruct the bot to automatically remove the label. This bot runs once per day.

@github-actions github-actions bot added the Stale Issues and pull requests which have been flagged for closing due to inactivity label Sep 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Stale Issues and pull requests which have been flagged for closing due to inactivity
Projects
None yet
Development

Successfully merging this pull request may close these issues.

✨ Set up Copilot instructions
2 participants