Skip to content

Update Copilot docs review instructions: emdash and context rules, fit 4k limit - #1271

Merged
maartenba merged 1 commit into
mainfrom
docs/copilot-review-instructions
Oct 19, 2026
Merged

maartenba merged 1 commit into
mainfrom
docs/copilot-review-instructions

Conversation

@maartenba

Copy link
Copy Markdown
Member

Updates .github/instructions/docs.instructions.md used by Copilot code review.

  • Copilot code review only reads the first 4,000 characters of an instruction file. The file was 4,070, so trailing rules were ignored. It is now ~3,040.
  • Adds a rule to avoid emdashes, preferring split sentences over ;.
  • Adds a Context section: include enough context (spec references, one sentence of "why"), as short as possible and as long as needed.
  • Deduplicates and condenses existing rules without dropping any.

@maartenba
maartenba requested a review from wcabus October 19, 2026 10:21
@maartenba maartenba self-assigned this Oct 19, 2026
@maartenba maartenba added the documentation Improvements or additions to documentation label Oct 19, 2026
@maartenba
maartenba enabled auto-merge October 19, 2026 10:21
@maartenba
maartenba merged commit 2af66fa into main Oct 19, 2026
7 checks passed
@maartenba
maartenba deleted the docs/copilot-review-instructions branch October 19, 2026 11:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants