You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/prompts/agentic-merge-upstream.prompt.md
+11-10Lines changed: 11 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,13 +37,12 @@ All scripts write/read a `.merge-env` file (git-ignored) to share state (branch
37
37
7. Run `./.github/scripts/build/format-and-test.sh` frequently while porting
38
38
8. Build the package
39
39
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
43
42
44
43
---
45
44
46
-
## Steps 1-2: Initialize and Analyze
45
+
## Step 1: Initialize Upstream Sync
47
46
48
47
Run the start script to create a branch, update the CLI, clone the upstream repo, and see a summary of new commits:
49
48
@@ -57,7 +56,9 @@ This writes a `.merge-env` file used by the other scripts. It outputs:
57
56
- The upstream dir path
58
57
- A short log of upstream commits since `.lastmerge`
59
58
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:
61
62
62
63
```bash
63
64
./.github/scripts/upstream-sync/merge-upstream-diff.sh # stat only
@@ -266,8 +267,8 @@ Verify:
266
267
## Step 9: Update Documentation
267
268
268
269
**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`).
271
272
272
273
### Documentation Checklist
273
274
@@ -322,7 +323,7 @@ Ensure consistency across all documentation files:
322
323
- Code examples should use the same patterns and be tested
323
324
- Links to Javadoc should use correct paths (`apidocs/...`)
324
325
325
-
## Steps 10-11: Finish, Push, and Finalize Pull Request
326
+
## Step 10: Finish, Push, and Finalize Pull Request
326
327
327
328
Run the finish script which updates `.lastmerge`, runs a final build, and pushes the branch:
328
329
@@ -384,7 +385,7 @@ Ports changes from the official Copilot SDK ([github/copilot-sdk](https://github
384
385
- Code formatted with Spotless
385
386
```
386
387
387
-
## Step 12: Final Review
388
+
## Step 11: Final Review
388
389
389
390
Before finishing:
390
391
@@ -417,7 +418,7 @@ Before finishing:
417
418
-[ ]`src/site/markdown/documentation.md` updated for new basic usage
418
419
-[ ]`src/site/markdown/advanced.md` updated for new advanced features
419
420
-[ ] 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
421
422
-[ ]`src/site/site.xml` updated if new documentation pages were added
422
423
-[ ]`.lastmerge` file updated with new commit hash
0 commit comments