Skip to content

Restructure upstream-merge prompt flow and add explicit documentation-impact gate#168

Merged
brunoborges merged 3 commits intomainfrom
copilot/fix-documentation-structure
Mar 3, 2026
Merged

Restructure upstream-merge prompt flow and add explicit documentation-impact gate#168
brunoborges merged 3 commits intomainfrom
copilot/fix-documentation-structure

Conversation

Copy link
Contributor

Copilot AI commented Mar 3, 2026

The upstream merge prompt’s detailed sections had drifted from the workflow outline, making execution order ambiguous. It also lacked a strong guard against recurring misses where user-facing upstream ports land without corresponding documentation updates.

  • Workflow structure alignment

    • Reordered and renumbered the prompt so the Workflow Overview and detailed sections map directly.
    • Established a single contiguous sequence (Step 1Step 11) and removed mismatched/ambiguous step groupings.
  • Documentation follow-through enforcement

    • Strengthened Step 9 guidance so documentation review is a required checkpoint before moving to finalization.
    • Added explicit fallback guidance: when user-facing changes do not require doc edits, PR body must include a concise rationale under a clear heading (e.g., Documentation Impact).
  • Checklist hardening

    • Updated the final checklist to require explicit explanation when docs are intentionally unchanged for user-facing upstream changes.
    • Kept scope limited to the upstream-merge prompt file; no runtime SDK behavior changes.
## Step 9: Update Documentation
Review and complete this documentation checklist before proceeding to Step 10.
If you determine no docs changes are needed, document that decision and rationale in the PR body under a clear heading (for example, `Documentation Impact`).
Original prompt

This section details on the original issue you should resolve

<issue_title>Prompt agentic-merge-upstream.prompt.md is not well structured</issue_title>
<issue_description>The workflow defines steps, but then the details of each step are not properly ordered / numbered based on the workflow outline.

More importantly, it is common that an agentic merge from upstream adds new capabilities but then forgets to update documentation. This has been a recurring problem.</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>
@brunoborges brunoborges marked this pull request as ready for review March 3, 2026 18:45
@brunoborges brunoborges requested a review from edburns as a code owner March 3, 2026 18:45
Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>
@brunoborges brunoborges merged commit b8976d7 into main Mar 3, 2026
4 checks passed
Copilot AI changed the title [WIP] Fix documentation structure for agentic merge workflow Restructure upstream-merge prompt flow and add explicit documentation-impact gate Mar 3, 2026
Copilot stopped work on behalf of brunoborges due to an error March 3, 2026 18:46
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.

Prompt agentic-merge-upstream.prompt.md is not well structured

3 participants