Skip to content

Commit b01482f

Browse files
Copilotbrunoborges
andcommitted
Align upstream merge prompt step numbering and docs guidance
Co-authored-by: brunoborges <129743+brunoborges@users.noreply.github.com>
1 parent 33bea43 commit b01482f

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

.github/prompts/agentic-merge-upstream.prompt.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,12 @@ All scripts write/read a `.merge-env` file (git-ignored) to share state (branch
3737
7. Run `./.github/scripts/build/format-and-test.sh` frequently while porting
3838
8. Build the package
3939
9. Update documentation (**required for every user-facing upstream change**)
40-
10. Run `./.github/scripts/upstream-sync/merge-upstream-finish.sh` (final test + push)
41-
11. Finalize Pull Request (see note below about coding agent vs. manual workflow)
42-
12. Perform final review before handing off
40+
10. Run `./.github/scripts/upstream-sync/merge-upstream-finish.sh` (final test + push) and finalize Pull Request (see note below about coding agent vs. manual workflow)
41+
11. Perform final review before handing off
4342

4443
---
4544

46-
## Steps 1-2: Initialize and Analyze
45+
## Step 1: Initialize Upstream Sync
4746

4847
Run the start script to create a branch, update the CLI, clone the upstream repo, and see a summary of new commits:
4948

@@ -57,7 +56,9 @@ This writes a `.merge-env` file used by the other scripts. It outputs:
5756
- The upstream dir path
5857
- A short log of upstream commits since `.lastmerge`
5958

60-
Then run the diff script for a detailed breakdown by area:
59+
## Step 2: Analyze Upstream Changes
60+
61+
Run the diff script for a detailed breakdown by area:
6162

6263
```bash
6364
./.github/scripts/upstream-sync/merge-upstream-diff.sh # stat only
@@ -266,8 +267,8 @@ Verify:
266267
## Step 9: Update Documentation
267268

268269
**Documentation is critical for new features.** Every new feature ported from upstream must be documented before the merge is complete.
269-
Do not proceed to the finish/push step until this documentation checklist is complete.
270-
If you determine no docs changes are needed, explicitly document that decision and rationale in the PR body.
270+
Review and complete this documentation checklist before proceeding to Step 10.
271+
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`).
271272

272273
### Documentation Checklist
273274

@@ -322,7 +323,7 @@ Ensure consistency across all documentation files:
322323
- Code examples should use the same patterns and be tested
323324
- Links to Javadoc should use correct paths (`apidocs/...`)
324325

325-
## Steps 10-11: Finish, Push, and Finalize Pull Request
326+
## Step 10: Finish, Push, and Finalize Pull Request
326327

327328
Run the finish script which updates `.lastmerge`, runs a final build, and pushes the branch:
328329

@@ -384,7 +385,7 @@ Ports changes from the official Copilot SDK ([github/copilot-sdk](https://github
384385
- Code formatted with Spotless
385386
```
386387

387-
## Step 12: Final Review
388+
## Step 11: Final Review
388389

389390
Before finishing:
390391

@@ -417,7 +418,7 @@ Before finishing:
417418
- [ ] `src/site/markdown/documentation.md` updated for new basic usage
418419
- [ ] `src/site/markdown/advanced.md` updated for new advanced features
419420
- [ ] Javadoc added/updated for new public APIs
420-
- [ ] If no documentation files were changed, PR body explicitly explains why documentation changes were not needed
421+
- [ ] If no documentation files were changed for user-facing upstream changes, PR body explicitly explains why documentation changes were not needed
421422
- [ ] `src/site/site.xml` updated if new documentation pages were added
422423
- [ ] `.lastmerge` file updated with new commit hash
423424
- [ ] Branch pushed to remote

0 commit comments

Comments
 (0)