infra[skiplog]: document release & backmerge PR conventions in sdk-pr-create skill#1858
Closed
simon-iribarren wants to merge 2 commits into
Closed
Conversation
…-create skill The sdk-pr-create skill covered normal feature/fix PRs but said nothing about the two other PR shapes that show up in the SDK release flow: - Release PRs (fork -> release-<pkg>-<ver>) — version bump + per-version changelog folder + aggregated CHANGELOG.md prepend. Merging triggers GPR publish. - Backmerge PRs (release-<pkg>-<ver> -> main) — bring the release artifacts back into main after publish, usually hand-crafted (not a git merge) so main's deps don't get regressed. Both shapes have established title conventions in this repo (precedent: tetherto#1726, tetherto#1645, tetherto#1552, tetherto#1301, tetherto#1781, tetherto#1782, tetherto#1857) but the rules and skill never spelled them out, leading to mis-tagged titles like "chore[notask|skiplog]: backmerge ..." with a ticket present (notask is for omitting the ticket, not a generic backmerge marker). Adds an explicit "Release & Backmerge PRs" section to the skill with: - Title format for each shape, with and without a ticket - Tag rules ([skiplog] required for backmerge, [notask] only when no ticket, [notask|skiplog] is a legitimate combination of the two metadata tags) - Body content guidance (link to release PR, explain hand-crafted merges, reference precedent backmerge for previous version) - A decision-rule table mapping PR shape -> base -> title format Also tightens the quality checklist to catch the two most common mistakes: ticket + [notask] in the same title, and missing [skiplog] on a backmerge. Workspace consumers (tether) already symlink this file from .cursor/skills/sdk-pr-create/SKILL.md, so the change reaches them as soon as it lands on main.
…erge PR bodies Follow-up to the earlier commit on this branch that added release & backmerge title conventions. Reviewer noted that the body of release / backmerge PRs should also use the standard sdk-pod template headings (🎯 What problem / 📝 How does it solve / 🧪 How was it tested) — not custom shapes like ## Summary / ## Changes / ## Test plan that I had been writing. Adds three things to the skill: - An explicit "Body always uses the same headings" callout in the Release & Backmerge PRs section, listing the standard headings and flagging custom alternatives as wrong. - A "Mapping release/backmerge content onto the template" subsection that shows how to fit each PR shape's content into the standard sections (e.g. for a backmerge: justify a hand-crafted merge in ## 🧪 How was it tested?, including the dependency-divergence table). - A new quality-checklist line forbidding custom headings. Also updates the decision-rule table to add a "Body" column making it explicit that all three PR shapes use the same template.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note: be concise and prefer bullet points.
🎯 What problem does this PR solve?
sdk-pr-createskill told us how to write normal PR titles (TICKET prefix[tags]: subject) but said nothing about the two other PR shapes that show up in the SDK release flow: release PRs (fork →release-<pkg>-<ver>) and backmerge PRs (release-<pkg>-<ver>→main).## Summary/## Changes/## Test plan(e.g. PR QVAC-18184 chore[skiplog]: backmerge release sdk 0.9.2 #1857 in its first revision).QVAC-18184 chore[notask|skiplog]: backmerge release sdk 0.9.2even though it has a ticket —[notask]is reserved for omitting the ticket. Right title:QVAC-18184 chore[skiplog]: backmerge release sdk 0.9.2.🎯 / 📝 / 🧪), breaking reviewer expectations and any tooling that scans for them.📝 How does it solve it?
.cursor/skills/sdk-pr-create/SKILL.mdcovering:[skiplog]required for backmerge,[notask]only when no ticket,[notask|skiplog]is a legit combination of the two metadata tags (distinct from the rule that content tags[api]/[bc]/[mod]cannot be combined)## Summary/## Changes/## Test plan## 🧪 How was it tested?)[notask]together, missing[skiplog]on backmerge, and custom headings in the body🧪 How was it tested?
.github/PULL_REQUEST_TEMPLATE/sdk-pod.mdto confirm the heading set the skill now requires..cursor/skills/sdk-pr-create/SKILL.md → repos/qvac/.cursor/skills/sdk-pr-create/SKILL.md, so this lands automatically there once merged onmain.