-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Add new copilot instructions #49030
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
Add new copilot instructions #49030
Conversation
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 migrates writing instructions to a new auto-triggering code file and adds Copilot instructions for common documentation tasks. The changes enhance the documentation workflow by providing structured guidance for snippet management, link updates, and writing style compliance.
Key Changes
- Migrated and streamlined writing style guidelines from general Copilot instructions to specialized auto-triggering instructions
- Added comprehensive snippet management instructions for pushing inline code to files and migrating legacy snippets
- Created a prompt for automated link text updates based on target content headings
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
.github/prompts/RefreshLinks.prompt.md |
New prompt for automatically updating link text to match target content headings |
.github/instructions/Snippets.Push.instructions.md |
Instructions for extracting inline code blocks into standalone snippet files |
.github/instructions/Snippets.Migrate.instructions.md |
Guidelines for migrating legacy snippets from old to new repository structure |
.github/instructions/Markdown.WritingStyle.instructions.md |
Auto-triggering writing style guidelines for Markdown documentation |
.github/copilot-instructions.md |
Streamlined general Copilot instructions with updated AI usage disclosure guidelines |
wadepickett
left a comment
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.
@adegeo, These copilot instruction files are excellent and a model to follow. Approved. I'm going to compare these with the collection we have for the ASP.NET Core docs repo to see if there is anything we might improve on based on yours.
I can't find any issues. It is well simplified, has concrete examples to follow, your formatting is effective for highlighting critical info for copilot (and humans.) Well done!
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
Internal previews