-
Notifications
You must be signed in to change notification settings - Fork 4.9k
Add comprehensive GitHub Copilot instructions for dotnet/core repository #10029
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
base: main
Are you sure you want to change the base?
Conversation
@jongalloway 👋 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: jongalloway <[email protected]>
…sitory Co-authored-by: jongalloway <[email protected]>
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 GitHub Copilot instructions to guide AI assistants working in the dotnet/core repository, which serves as a documentation and release notes repository rather than a buildable codebase. The instructions provide detailed workflows for validation, common tasks, and repository navigation.
- Added complete
.github/copilot-instructions.md
with repository-specific guidance and validated command workflows - Fixed JSON syntax error in markdown link check configuration by removing an invalid comment
- Updated instructions include timing expectations, troubleshooting guidance, and manual validation scenarios
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated 1 comment.
File | Description |
---|---|
.github/copilot-instructions.md |
New comprehensive instructions file covering repository structure, validation commands, and common workflows |
.github/workflows/markdown-link-check-config.json |
Fixed JSON syntax by removing invalid comment from ignorePatterns |
@@ -4,7 +4,7 @@ | |||
"pattern": "^http://localhost" | |||
}, | |||
{ | |||
"pattern": "^release-notes/templates/" // ignore links in docs directory | |||
"pattern": "^release-notes/templates/" |
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.
The removal of the JSON comment is correct as JSON does not support comments. However, this change removes documentation about what this pattern ignores. Consider adding this information to a separate documentation file or the README if this context is important for maintainers.
Copilot uses AI. Check for mistakes.
@copilot Please address the comment by adding a separate markdown doc, remove the comment, and ensure validation passes. |
I've added the comprehensive GitHub Copilot instructions in ✅ Markdown linting: Passed The instructions provide complete guidance for working in this documentation repository, including validated command workflows, repository structure details, and timing expectations. Commit: 15fbed0 Warning Firewall rules blocked me from connecting to one or more addressesI tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
@copilot The build checks are still failing. Specifically, JSON_PRETTIER is reporting an error. Please fix. |
Co-authored-by: jongalloway <[email protected]>
Fixed! The JSON_PRETTIER error was caused by incorrect line endings in ✅ Markdown linting: Passed Commit: eb1c946 Warning Firewall rules blocked me from connecting to one or more addressesI tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
This PR adds a comprehensive
.github/copilot-instructions.md
file that provides GitHub Copilot with detailed guidance on how to work effectively in the dotnet/core repository.What this adds
The instructions file provides:
/release-notes/
,/Documentation/
, and workflow filesKey features
Additional fixes
.github/workflows/markdown-link-check-config.json
(corrected line endings from CRLF to LF)The instructions start with the required directive: "Always reference these instructions first and fallback to search or bash commands only when you encounter unexpected information that does not match the info here."
All validation commands have been tested and work correctly:
Fixes #10028.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.