From 590b49edc158611a2b2ed715ae73f27eb70d251a Mon Sep 17 00:00:00 2001 From: Anton Panasenko Date: Mon, 18 May 2026 16:16:36 -0700 Subject: [PATCH] [codex] make yeet template-aware (#412) ## Why The curated `yeet` skill was missing guidance for common publish-flow cases: repositories with PR templates, branches that already have a PR, and PR bodies that need to preserve reviewer-relevant context instead of generic boilerplate. ## What Changed Updated `skills/.curated/yeet/SKILL.md` to make the publish workflow template-aware and branch-aware. The skill now tells Codex to discover the active repository PR template before creating a PR, reuse an existing PR for the current branch instead of creating a duplicate, preserve an existing PR's draft or ready-for-review state, apply conventional PR title guidance, and write PR bodies around the net change with meaningful verification only when there is behavioral evidence worth preserving. --- skills/.curated/yeet/SKILL.md | 110 +++++++++++++++++++++++++++++++++- 1 file changed, 107 insertions(+), 3 deletions(-) diff --git a/skills/.curated/yeet/SKILL.md b/skills/.curated/yeet/SKILL.md index 7d191fb..acce563 100644 --- a/skills/.curated/yeet/SKILL.md +++ b/skills/.curated/yeet/SKILL.md @@ -14,6 +14,27 @@ description: "Use only when the user explicitly asks to stage, commit, push, and - Commit: `{description}` (terse). - PR title: `{description}` summarizing the full diff. +## PR template discovery + +Before creating the PR, resolve the repository root and look for the active GitHub PR template from there: + +```shell +repo_root="$(git rev-parse --show-toplevel)" +``` + +Template candidates, in order: + +- `.github/pull_request_template.md` +- `.github/PULL_REQUEST_TEMPLATE.md` +- One `*.md` file under `.github/pull_request_template/` +- One `*.md` file under `.github/PULL_REQUEST_TEMPLATE/` + +Use paths as emitted from the repository root, such as `.github/pull_request_template.md`, not `./.github/pull_request_template.md`. + +If exactly one template is found, read it before composing the final PR body and pass it to `gh pr create` with `--template "$template"`. + +If multiple template files are found, stop before PR creation and ask which template to use. If no template exists, use the fallback body shape in this skill. + ## Workflow - If on main/master/default, create a branch: `git checkout -b "{description}"` @@ -23,6 +44,89 @@ description: "Use only when the user explicitly asks to stage, commit, push, and - Run checks if not already. If checks fail due to missing deps/tools, install dependencies and rerun once. - Push with tracking: `git push -u origin $(git branch --show-current)` - If git push fails due to workflow auth errors, pull from master and retry the push. -- Open a PR and edit title/body to reflect the description and the deltas: `GH_PROMPT_DISABLED=1 GIT_TERMINAL_PROMPT=0 gh pr create --draft --fill --head $(git branch --show-current)` -- Write the PR description to a temp file with real newlines (e.g. pr-body.md ... EOF) and run pr-body.md to avoid \\n-escaped markdown. -- PR description (markdown) must be detailed prose covering the issue, the cause and effect on users, the root cause, the fix, and any tests or checks used to validate. +- Discover and read the repository PR template, if any. +- Check whether the current branch already has a PR: `gh pr view "$(git branch --show-current)" --json number,isDraft,url` +- If a PR already exists, update that PR in place. Do not create another PR, and do not change whether the existing PR is draft or ready for review. +- If no PR exists, open a new draft PR: + - With one template: `GH_PROMPT_DISABLED=1 GIT_TERMINAL_PROMPT=0 gh pr create --draft --fill --template "$template" --head "$(git branch --show-current)"` + - Without a template: `GH_PROMPT_DISABLED=1 GIT_TERMINAL_PROMPT=0 gh pr create --draft --fill --head "$(git branch --show-current)"` +- Edit the PR title and body so they reflect the actual net change in the diff. +- Write the PR description to a temp file with real newlines and pass it via `--body-file` or `gh pr edit --body-file` to avoid `\n`-escaped markdown. + +## Determining the PR + +When updating a PR created earlier in the flow, infer the PR from the current branch when possible: + +```shell +git branch --show-current +gh pr view "$(git branch --show-current)" --json number --jq '.number' +``` + +If this finds an existing PR, preserve its current review state. Never convert an existing ready-for-review PR back to draft as part of `yeet`; only new PRs created by this flow should start as draft. + +## PR Title + +Format: `(): ` + +`` is optional. A scope consist of a noun describing a section of the codebase (component, service or subsytem). + +### Example + +``` +feat: add hat wobble +^--^ ^------------^ +| | +| +-> Summary in present tense. +| ++-------> Type: chore, docs, feat, fix, refactor, style, or test. +``` + +More Examples: + +- `feat`: (new feature for the user, not a new feature for build script) +- `fix`: (bug fix for the user, not a fix to a build script) +- `docs`: (changes to the documentation) +- `style`: (formatting, missing semi colons, etc; no production code change) +- `refactor`: (refactoring production code, eg. renaming a variable) +- `test`: (adding missing tests, refactoring tests; no production code change) +- `chore`: (updating grunt tasks etc; no production code change) + + +## PR Body Contents + +When invoked, use `gh` to edit the pull request body and title to reflect the contents of the specified PR. Make sure to check the existing pull request body to see if there is key information that should be preserved. For example, NEVER remove an image in the existing pull request body, as the author may have no way to recover it if you remove it. + +When a repository PR template exists, adapt the final PR body to that template. Preserve meaningful headings, required checklists, and repo-specific prompts, but replace placeholder text with net-diff-specific content or `N/A` where the template asks for it. Do not discard template sections just because the fallback shape below is shorter. + +It is critically important to explain _why_ the change is being made. If the current conversation in which this skill is invoked has discussed the motivation, be sure to capture this in the pull request body. + +The body should also explain _what_ changed, but this should appear after the _why_. + +Limit discussion to the _net change_ of the commit. It is generally frowned upon to discuss changes that were attempted but later undone in the course of the development of the pull request. When rewriting the pull request body, you may need to eliminate details such as these when they are no longer appropriate / of interest to future readers. + +Avoid references to absolute paths on my local disk. When talking about a path that is within the repository, simply use the repo-relative path. + +Default to omitting `Verification`. Add it only when you have behavioral evidence worth preserving for reviewers: a reproduced bug, a before/after check, a targeted test that exercises the changed behavior, or a manual scenario with input and observed outcome. Do not use it for generic commands or automation results such as package tests, type checks, linters, formatters, pre-commit/pre-push hooks, or CI status. + +If the repository template requires a validation or verification section, keep that section and avoid generic filler: include meaningful commands/results, a targeted manual scenario, or `Not run` with a reason. + +Use professional Markdown: + +- Put code, paths, commands, flags, and identifiers in backticks. +- Use fenced code blocks for shell transcripts or multi-line examples. +- Use GitHub permalinks when citing existing code relevant to the change. +- Reference relevant issues or related PRs, but do not reference the PR in its own body. + +### Suggested PR Body Shape + +Use this as a fallback when the repository does not have a PR template: + +```markdown +## Why + +Describe the user-facing or maintainer-facing problem, including cause and effect where useful. + +## What Changed + +Describe the net implementation change in concise prose. +```