Skip to content

Remove stale PR note from Copilot instructions#34566

Merged
jfversluis merged 1 commit intomainfrom
fix/remove-stale-pr-note-instruction
Mar 20, 2026
Merged

Remove stale PR note from Copilot instructions#34566
jfversluis merged 1 commit intomainfrom
fix/remove-stale-pr-note-instruction

Conversation

@jfversluis
Copy link
Member

Description

Remove the "Are you waiting for the changes in this PR to be merged?" note from all Copilot instruction files.

This note was previously required at the top of every PR description so users could find instructions on how to test PR artifacts. We now have a dogfooding comment bot that automatically posts testing instructions under each PR, making this manual note redundant.

Copilot agents were still prepending this note to every PR description because it was hardcoded in:

  • .github/copilot-instructions.md (main instructions)
  • .github/skills/pr-finalize/SKILL.md (PR finalization skill)
  • .github/skills/pr-finalize/references/complete-example.md (example PR)

Issues Fixed

N/A — instruction cleanup only.

The dogfooding comment bot now automatically adds testing instructions
to every PR, making this manual note redundant. Remove it from all
Copilot instruction files so agents stop prepending it to PR
descriptions.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 19, 2026 12:36
@github-actions
Copy link
Contributor

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/dotnet/maui/main/eng/scripts/get-maui-pr.sh | bash -s -- 34566

Or

  • Run remotely in PowerShell:
iex "& { $(irm https://raw.githubusercontent.com/dotnet/maui/main/eng/scripts/get-maui-pr.ps1) } 34566"

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Removes the previously hardcoded “test PR artifacts” NOTE block guidance from Copilot instruction/skill documentation, aligning the repo’s agent guidance with the new approach where a bot posts testing instructions automatically.

Changes:

  • Removed the NOTE block requirement and template snippets from the pr-finalize skill documentation.
  • Updated the pr-finalize “complete example” reference to no longer include the NOTE block.
  • Removed the “Opening PRs” section from .github/copilot-instructions.md that mandated the NOTE block.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
.github/skills/pr-finalize/SKILL.md Drops NOTE block requirement/examples (but still contains other NOTE-block mentions that should be updated for consistency).
.github/skills/pr-finalize/references/complete-example.md Updates example PR description to remove the NOTE block section.
.github/copilot-instructions.md Removes the “Opening PRs” NOTE-block mandate from general Copilot instructions.
Comments suppressed due to low confidence (1)

.github/copilot-instructions.md:206

  • The PR description says the stale PR note was removed from all Copilot instruction files, but there’s still a copy under custom-instructions/repo/.github/copilot-instructions.md that contains the NOTE block and Testing-PR-Builds link. If that directory is used by tooling, it will keep reintroducing the stale guidance; otherwise consider deleting/clarifying its purpose.
- `.github/instructions/xaml-unittests.instructions.md` - XAML unit test guidelines


## Custom Agents and Skills

The repository includes specialized custom agents and reusable skills for specific tasks.

You can also share your feedback on Copilot code review. Take the survey.

Comment on lines +130 to +131
1. Include the base sections from `.github/PULL_REQUEST_TEMPLATE.md` ("Description of Change" and "Issues Fixed"). The skill adds additional structured fields (Root cause, Fix, Key insight, etc.) as recommended enhancements for better agent context.
2. Match the actual implementation
@jfversluis jfversluis merged commit 7652fb6 into main Mar 20, 2026
9 of 10 checks passed
@jfversluis jfversluis deleted the fix/remove-stale-pr-note-instruction branch March 20, 2026 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants