Skip to content
Merged
Changes from 1 commit
Commits
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
26 changes: 26 additions & 0 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,32 @@ 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/topic at a time - never combine multiple versions in a single PR.
- Copy working code samples directly from source when available.
- Execute and validate all code examples with appropriate tools (`dotnet fsi` for F#, simple console apps for C#).
- Provide execution proofs in PR comments for any generated code.
- 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.

**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 (% copied vs. generated).
- List of fabricated/generated sections requiring expert review.
- Execution proof for all code samples.
- Clear warnings about any uncertainties.

## Special Cases

### Breaking Changes
Expand Down