Skip to content

Commit 7167156

Browse files
authored
Merge branch 'main' into copilot/update-changelog-faster-examples
2 parents 55f42d3 + ec3d373 commit 7167156

1 file changed

Lines changed: 11 additions & 9 deletions

File tree

.github/workflows/upstream-sync.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -202,21 +202,24 @@ Before creating the PR, review your own changes:
202202

203203
### Phase 7: Create the PR
204204

205-
Create a pull request with:
205+
First, if the change is complex or warrants discussion, create a **tracking issue** describing:
206+
- The upstream changes being ported
207+
- Your analysis and implementation approach
208+
- Any design decisions or trade-offs
209+
210+
Then **always proceed to implement and create a pull request**. Do not stop at the issue.
211+
212+
Create the pull request with:
206213

207214
- **Title**: `[upstream-sync] Port changes from copilot-sdk vX.Y.Z` (or specific PR titles if only a few)
208215
- **Body** including:
216+
- `Closes #NN` (referencing the tracking issue, if one was created) so the issue auto-closes on merge
209217
- Summary of upstream changes ported
210218
- List of upstream PRs referenced (with links)
211219
- Changes skipped and why
212220
- Testing performed
213221
- Any notes for the reviewer
214222

215-
If the changes are too complex or ambiguous to implement confidently, create an **issue** instead of a PR, describing:
216-
- The upstream changes that need attention
217-
- Why automated porting was not feasible
218-
- Suggested approach for manual implementation
219-
220223
### Phase 8: Update Cache
221224

222225
After creating the PR (or noop/issue), update cache-memory with:
@@ -226,14 +229,13 @@ After creating the PR (or noop/issue), update cache-memory with:
226229

227230
## Guidelines
228231

229-
- **Be conservative**: When in doubt, create an issue for human review rather than making a risky change.
232+
- **Always implement**: Do not stop at creating an issue. Always proceed to implement the changes and create a PR. Use issues as tracking items that the PR closes, not as alternatives to implementation.
230233
- **Small PRs**: If there are many upstream changes, prefer creating one focused PR per logical change rather than one massive PR.
231234
- **Respect the design philosophy**: This is an idiomatic Clojure library, not a line-by-line translation.
232235
- **Wire format matters**: Protocol/wire code must match upstream exactly. Clojure idioms apply to the API surface, not the wire format.
233236
- **Version sync**: If upstream has a new release version, note it but do NOT bump versions — that's done by the maintainer.
234237

235238
## Safe Outputs
236239

237-
- **If changes were ported**: Use `create-pull-request` with the implementation branch.
238-
- **If changes need human review**: Use `create-issue` describing what needs attention.
240+
- **If changes were ported**: Use `create-issue` first (if helpful for tracking), then `create-pull-request` with `Closes #NN` in the body.
239241
- **If no relevant changes found**: Call `noop` with a message like "No upstream changes require porting since last sync on YYYY-MM-DD."

0 commit comments

Comments
 (0)