Skip to content

Commit c1b3ff6

Browse files
authored
Incorporate new copilot recommendations (#50084)
* Incorporate new recommendations See discussion on #49119 * holistically respond to feedback I didn't take any of the suggestions as noted, but made edits consistent will all recommendations. * Update .github/copilot-instructions.md
1 parent 0412742 commit c1b3ff6

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

.github/copilot-instructions.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,30 @@ 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, 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.
67+
- Copy working code samples directly from source when available. Follow the rules under ["Code Snippets"](#code-snippets) above.
68+
- Create a checklist TODO for each section of the source document before writing.
69+
- Map each documentation section 1:1 to source content.
70+
- Explicitly state what is copied vs. generated in PR description.
71+
- Add disclaimers about AI usage when applicable.
72+
73+
**DON'T:**
74+
- Invent or elaborate on features not explicitly mentioned in source.
75+
- Create placeholder sections without content.
76+
- Assume feature details or characteristics.
77+
- Combine information from multiple versions/sources.
78+
- Add examples without verifying they demonstrate the stated feature.
79+
80+
**PR Description Must Include:**
81+
- Content source breakdown. In the description, list each section of the source document and indicate whether it was copied verbatim, adapted, or newly generated.
82+
- Note all generated sections requiring expert review.
83+
- Clear warnings about any uncertainties.
84+
6185
## Special Cases
6286

6387
### Breaking Changes

0 commit comments

Comments
 (0)