-
Notifications
You must be signed in to change notification settings - Fork 2
Add comprehensive GitHub Copilot instructions for development workflow #80
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
@kieronlanning 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs. I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review. |
Co-authored-by: kieronlanning <5364423+kieronlanning@users.noreply.github.com>
Updated the Purview Telemetry Source Generator documentation to clarify it is an incremental source generator and added detailed instructions for building, testing, and validation.
There was a problem hiding this 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 adds comprehensive development workflow instructions for GitHub Copilot coding agents working with the Purview Telemetry Source Generator codebase. The instructions provide detailed guidance on prerequisites, build processes, testing procedures, and project architecture to help AI agents work effectively in this .NET source generator project.
Key changes:
- Added complete setup and prerequisite instructions with exact installation commands
- Documented all build, test, and validation workflows with timing expectations
- Included critical timeout warnings to prevent premature cancellation of long-running operations
Comments suppressed due to low confidence (1)
.github/copilot-instructions.md:1
- The curl flags are inconsistent between the two dotnet installation commands. Line 13 uses
-sSLwhile line 14 uses-fsSL. For consistency, both should use the same flags (recommend-fsSLas it includes fail-fast behavior).
# Purview Telemetry Source Generator
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Created a comprehensive
.github/copilot-instructions.mdfile that provides GitHub Copilot coding agents with detailed instructions for working effectively in this .NET source generator codebase.Key Features
Prerequisites & Setup: Exact installation commands for all required dependencies:
DOTNET_ROOT,PATH)Validated Build & Test Commands: All commands have been tested and include measured timing:
make build- builds source generator and integration tests (26 seconds)make test- runs 282 integration tests (42 seconds)make format- code formatting with .editorconfig rules (21 seconds)Critical Timeout Warnings: Explicit "NEVER CANCEL" warnings with recommended timeout values:
Functional Validation Requirements: Specific scenarios for testing source generator changes:
obj/generated/directoriesProject Architecture Documentation: Complete structure overview including:
src/Purview.Telemetry.SourceGenerator/)The instructions emphasize exhaustive validation, proper timing expectations, and functional testing to ensure source generator changes work correctly end-to-end.
Fixes #79.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.