Add comprehensive GitHub Copilot instructions for OpenTelemetry Rust development #3160
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds detailed GitHub Copilot instructions to help developers work effectively with the OpenTelemetry Rust codebase. The instructions are based on comprehensive testing and validation of all build, test, and development workflows.
What's included
The
.github/copilot-instructions.md
file provides:Setup and Dependencies
cargo-hack
andcargo-msrv
Build and Test Commands with Measured Timings
Example timing data:
cargo check --workspace
: ~1m 15s (recommend 90s+ timeout)./scripts/test.sh
: ~4 minutes (recommend 480s+ timeout)./scripts/lint.sh
: ~6 minutes (recommend 480s+ timeout)Validation Scenarios
Project Structure
Working Examples
All examples tested and validated:
Validation
Every command mentioned in the instructions has been tested and validated:
The instructions follow the requirement to "always follow the instructions and only fallback to additional search and context gathering if the information is incomplete or found to be in error."
Fixes #3159.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
esm.ubuntu.com
/usr/lib/apt/methods/https
(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💡 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.