docs: Enhance Copilot instruction files for project files#621
Merged
docs: Enhance Copilot instruction files for project files#621
Conversation
…dation guidelines
Contributor
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughThis change introduces a comprehensive set of instruction files under Changes
Sequence Diagram(s)sequenceDiagram
participant Contributor
participant InstructionFile
participant Maintainer
participant CI/Bot
Contributor->>InstructionFile: Locate relevant instruction file for file type
InstructionFile-->>Contributor: Provide procedural/validation/escalation guidelines
Contributor->>CI/Bot: Submit PR with validation evidence
CI/Bot-->>Contributor: Automated feedback and checks
Contributor->>Maintainer: Escalate if blocked/uncertain or upon instruction
Maintainer-->>Contributor: Provide guidance/review
Contributor->>CI/Bot: Address all feedback before review/merge
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (14)
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferences |
…tignore, and MSBuild files with validation guidelines
…, and add examples for JSON and shell scripts
…idance and reference
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances GitHub Copilot instruction files to provide comprehensive, self-contained guidance for editing various file types in the repository. The update ensures that Copilot has complete context when working with different file types without needing to traverse external references.
Key Changes:
- Creates comprehensive instruction files for 11 different file types (C#, YAML, XML, JSON, etc.)
- Establishes consistent validation checklists and escalation procedures across all file types
- Adds decision trees for complex scenarios and multi-file changes
Reviewed Changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
.github/instructions/yaml.instructions.md |
New comprehensive guide for YAML/CI workflow files with security and performance validation |
.github/instructions/xml.instructions.md |
New guide for XML files focusing on documentation standards and schema compliance |
.github/instructions/text.instructions.md |
New guide for text files with formatting and content validation requirements |
.github/instructions/shell.instructions.md |
New guide for shell scripts emphasizing security, error handling, and testing |
.github/instructions/project.instructions.md |
New guide for project files (.csproj/.sln) with build and dependency management |
.github/instructions/msbuild.instructions.md |
New concise guide for MSBuild property/target files |
.github/instructions/markdown.instructions.md |
New guide for markdown files with documentation standards |
.github/instructions/json.instructions.md |
New guide for JSON configuration files with validation requirements |
.github/instructions/gitignore.instructions.md |
New concise guide for .gitignore file modifications |
.github/instructions/generic.instructions.md |
New fallback guide for unknown file types with decision trees |
.github/instructions/editorconfig.instructions.md |
New guide for .editorconfig formatting rules |
.github/instructions/csharp.instructions.md |
Enhanced C# guide with decision trees and test data guidelines |
.github/instructions/README.md |
New index mapping file patterns to instruction files |
.github/copilot-instructions.md |
Enhanced with quick reference table, validation requirements, and maintenance notes |
Comments suppressed due to low confidence (4)
.github/copilot-instructions.md:25
- The instruction specifies targeting .NET 9 and C# 13, but according to my knowledge cutoff, these versions do not exist. The latest stable versions are .NET 8 and C# 12. The quick reference table correctly mentions .NET 8 and C# 12, creating an inconsistency.
You are an experienced .NET developer working on Roslyn analyzers for the Moq framework. All code must target **.NET 9** and **C# 13**. Use only official .NET patterns and practices—**never** StackOverflow shortcuts. Keep responses clear, concise, and at a grade 9 reading level. Use plain English, avoid jargon. Follow SOLID, DRY, and YAGNI principles. Respond directly and keep explanations straightforward.
.github/instructions/project.instructions.md:34
- While .NET 8 and C# 12 are valid versions according to my knowledge, there's an inconsistency with the main copilot-instructions.md file which mentions .NET 9 and C# 13. This creates conflicting guidance.
- [ ] Target .NET 8, C# 12 by default; Analyzers and Code Fixes target .NET Standard 2.0
.github/instructions/project.instructions.md:148
- References .NET 9 which does not exist according to my knowledge cutoff. This is inconsistent with line 34 which correctly mentions .NET 8.
1. **Check compatibility** with target framework (.NET 9)
.github/instructions/json.instructions.md:181
- References .NET 9 which does not exist according to my knowledge cutoff. Should be .NET 8 to be consistent with other parts of the documentation.
- Ensure compatibility with target framework (.NET 9)
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Bugbot free trial expires on July 29, 2025
Learn more in the Cursor dashboard.
| | Instruction Files | Read and comply with all `.github/instructions/*` for edited file types | | ||
|
|
||
| --- | ||
|
|
There was a problem hiding this comment.
Bug: Mixed Framework Versions in Documentation
Conflicting .NET and C# target framework versions are specified across the documentation. copilot-instructions.md contains internal inconsistencies (referencing both .NET 8/C# 12 and .NET 9/C# 13), and these contradictions extend to other instruction files like project.instructions.md and json.instructions.md. This creates confusion for developers and AI agents regarding the correct target framework.
Locations (3)
13 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Update instruction files to provide clearer guidance for GitHub Copilot when editing C# and project files. Include mandatory instructions, validation checklists, and maintenance notes to ensure comprehensive understanding and adherence to development standards.
Summary by CodeRabbit