Skip to content

Commit c690a12

Browse files
committed
Incorporate new recommendations
See discussion on #49119
1 parent fd5a202 commit c690a12

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

.github/copilot-instructions.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,32 @@ Examples:
5858
- ❌ Bad: `configure_logging.md`
5959
- ❌ Bad: `DependencyInjectionGuidelines.md`
6060

61+
## Documentation from External Sources (Blog Posts, Announcements)
62+
63+
When adapting content from external sources like blog posts into documentation:
64+
65+
**DO:**
66+
- Work on one version/topic at a time - never combine multiple versions in a single PR.
67+
- Copy working code samples directly from source when available.
68+
- Execute and validate all code examples with appropriate tools (`dotnet fsi` for F#, simple console apps for C#).
69+
- Provide execution proofs in PR comments for any generated code.
70+
- Create a checklist TODO for each section of the source document before writing.
71+
- Map each documentation section 1:1 to source content.
72+
- Explicitly state what is copied vs. generated in PR description.
73+
74+
**DON'T:**
75+
- Invent or elaborate on features not explicitly mentioned in source.
76+
- Create placeholder sections without content.
77+
- Assume feature details or characteristics.
78+
- Combine information from multiple versions/sources.
79+
- Add examples without verifying they demonstrate the stated feature.
80+
81+
**PR Description Must Include:**
82+
- Content source breakdown (% copied vs. generated).
83+
- List of fabricated/generated sections requiring expert review.
84+
- Execution proof for all code samples.
85+
- Clear warnings about any uncertainties.
86+
6187
## Special Cases
6288

6389
### Breaking Changes

0 commit comments

Comments
 (0)