Skip to content

Incorporate new copilot recommendations #50084

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Nov 21, 2025
Merged

Incorporate new copilot recommendations #50084

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c690a12
Incorporate new recommendations
BillWagner Nov 21, 2025
e46e104
holistically respond to feedback
BillWagner Nov 21, 2025
958cc49
Update .github/copilot-instructions.md
BillWagner Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,30 @@ Examples:
- ❌ Bad: `configure_logging.md`
- ❌ Bad: `DependencyInjectionGuidelines.md`

## Documentation from External Sources (Blog Posts, Announcements)

When adapting content from external sources like blog posts into documentation:

**DO:**
- Work on one version, or topic at a time - never combine multiple versions in a single PR. Some blog posts or source material may include many versions or preview builds. The issue or task should specify which one to focus on.
- Copy working code samples directly from source when available. Follow the rules under ["Code Snippets"](#code-snippets) above.
- Create a checklist TODO for each section of the source document before writing.
- Map each documentation section 1:1 to source content.
- Explicitly state what is copied vs. generated in PR description.
- Add disclaimers about AI usage when applicable.

**DON'T:**
- Invent or elaborate on features not explicitly mentioned in source.
- Create placeholder sections without content.
- Assume feature details or characteristics.
- Combine information from multiple versions/sources.
- Add examples without verifying they demonstrate the stated feature.

**PR Description Must Include:**
- Content source breakdown. In the description, list each section of the source document and indicate whether it was copied verbatim, adapted, or newly generated.
- Note all generated sections requiring expert review.
- Clear warnings about any uncertainties.

## Special Cases

### Breaking Changes
Expand Down