| name | pr-writer |
| description | Prepare and publish SwiftStreamingMarkdown pull requests end-to-end: generate PR description, commit changes, create/push branch, and open a PR when needed. |
PR Writer
Prepare pull requests end-to-end by generating the PR description and handling the publish flow (commit -> branch -> push -> PR creation when needed).
When to Activate
- User asks to write, open, or update a PR
- User asks to commit, push, and open a PR for current branch changes
- User says "ship this", "publish this", "make a PR", or similar
End-to-End Publish Workflow
[!IMPORTANT]
If the current branch already has an open PR, always ask the user before doing anything else whether the new work should (a) be pushed as additional commits to the existing PR, or (b) go on a new branch (off the appropriate base, usually main) as a separate PR.
Never assume the user wants to extend the open PR, even if the new work feels related. Scope, review timing, and merge-queue considerations are the user's call. Do not commit, branch, or push until the user has answered.
-
Check repository and PR state
- Confirm current branch and dirty working tree using
git status.
- Check if branch already has an open PR:
gh pr view --json number,url,headRefName,baseRefName,state
- If an open PR exists on the current branch, stop and ask the user whether to push to that PR or start a new branch. Wait for the answer before proceeding to any other step. Quote the existing PR's number/title/URL in the question so the user can decide with full context.
- If the user picks "new branch", create it off the appropriate base (usually
main) in step 4 below before any commit.
-
Generate PR description body
- Produce the PR body using the template in this skill (mirrors
.github/pull_request_template.md).
- Ensure title is a clear, sentence-case description of the change (see conventions below).
-
Commit current changes
- Treat the current branch working tree as source of truth even if prior session history is unavailable.
- Include both staged and unstaged tracked code/doc/config changes that are relevant to the PR scope.
- Exclude obvious temporary artifacts (for example root-level screenshots, ad-hoc logs, dumps, tmp/debug files) unless explicitly requested.
- Stage relevant files and create a commit with a clear message.
- Include the standard co-author trailer unless the user opts out:
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- If there are no changes to commit, skip commit creation and continue.
-
Create or switch to a publish branch
- If current branch is a protected/shared branch (for example
main), create a feature branch with a hyphenated descriptive name.
- Otherwise keep using current feature branch.
-
Push branch
- Push with upstream tracking:
git push -u origin <branch>
- Never force-push to update a PR. Do not use
git push --force or git push --force-with-lease under any circumstance. To update a PR, always add a new commit on top — never rewrite, amend, or squash already-pushed history. If the push is rejected as non-fast-forward, stop and ask the user; do not "fix" it with force.
-
Create PR only if one does not already exist
- If no open PR exists for the branch, create one:
gh pr create --title "<title>" --body "<body>" --base main --head <branch>
- If PR already exists, update body/title as needed instead of creating duplicates.
- Update existing PR metadata when work is already partially published:
gh pr edit <PR_NUMBER> --title "<title>" --body "<body>"
- If branch and PR already exist and no new commit is needed, run metadata update only.
-
Return publication result
- Report commit SHA, branch name, push status, and PR URL.
Partial-State Handling (Some Steps Already Done)
- Existing branch + existing PR + new code changes:
- Ask the user first whether the new changes belong on this PR or on a new branch (see the IMPORTANT callout above). If "this PR": commit/push changes, then update PR body/title with
gh pr edit. If "new branch": create a fresh branch off main and run the normal flow there.
- Existing branch + existing PR + no code changes:
- Skip commit/push and update PR description/title only.
- Existing branch + no PR:
- Push branch if needed, then create PR with generated body.
- No branch/PR yet:
- Create branch, commit, push, then create PR.
- Session reset/compaction or new-agent context with unknown edit history:
- Do not rely on prior agent edit memory.
- Use the current
git status/diff as the canonical change set, apply temp-file filtering, then proceed with normal commit/push/PR flow.
Branch Naming Convention
This repo uses hyphenated descriptive branch names (no username prefix):
citation-config
citation-config-followup
configurability-followup
style-configurability
text-fonts-refactor
latex-configurability
PR Title Conventions
Use a clear, sentence-case description of the change. No [TAG] prefixes, no ticket IDs, no conventional-commit prefixes are required.
Examples (from recent merged PRs):
Convert CitationCoder to public Hashable struct on CitationConfigClean up InlineCitationConstants and merge citation predicatesAdd CitationConfig to MarkdownRenderConfig; remove dead Typography propsStyle folder; UIFont inline link/code; optional letterSpacing/lineHeightIntroduce TextFonts struct and decouple style config from Typography enum
PR Template
The repo template (.github/pull_request_template.md) has three sections plus an OSS-readiness checklist:
## Summary
<!-- What changed and why? -->
## Validation
<!-- List the checks you ran, for example: make test && make build -->
## OSS readiness
- [ ] No secrets, internal URLs, private identifiers, or product-only service names were added.
- [ ] Public docs, fixtures, or notices were updated if behavior or dependencies changed.
- [ ] Third-party dependency changes (adds, removes, version bumps) are intentional and reviewed.
- [ ] Streaming/incomplete markdown behavior remains covered by fixtures or tests.
Template Filling Guidelines
Summary
- Lead with what changed and why (one or two sentences).
- For multi-part changes, use a short bullet list of the concrete pieces (files, types, behaviors).
- Always reference the related GitHub issue. Every PR must cite the issue it addresses using a closing keyword on its own line so GitHub auto-links and auto-closes it on merge:
Closes #<issue-number> for issues this PR fully resolvesFixes #<issue-number> for bug-fix PRsRefs #<issue-number> when the PR is related but does not close the issue (for stacked work, partial progress, or follow-ups)- Use the full
owner/repo#<number> form when referencing an issue in a different repository.
- If no issue exists yet, create one first with
gh issue create and reference it. Do not open a PR without a linked issue unless the user explicitly waives this (e.g. for trivial docs/typo fixes).
- For large PRs, note scope and any follow-ups at the top.
Validation
- List the actual commands you ran and their result. Common ones in this repo:
make testmake build-sampleswift build / swift test for SwiftPM-only checks
- Mention snapshot test runs explicitly when relevant (record vs validate; see the
snapshot-tests skill).
- For UI changes, mention manual verification in the sample app and any VoiceOver/accessibility checks.
- Brief is fine when no new tests apply: "Existing test suite passes locally."
OSS readiness
- Tick each box honestly. Leave unchecked items visible so the reviewer can see what still needs attention.
- If a row genuinely does not apply (for example no dependency change), tick it and append a short note like
(no dependency changes).
Screenshots (optional)
- Not part of the committed template, but add a
## Screenshots section when UI/rendering changes warrant it.
- Use GitHub's image upload format with explicit dimensions:
<img width="568" height="1084" alt="..." src="..." />
- Light and dark variants are valuable for theme-related changes.
Example PR Body
## Summary
Convert `CitationCoder` from an internal helper into a public `Hashable` struct on `CitationConfig`, so external consumers can construct and compare their own coders. Default values are unchanged behaviorally.
- Promote `CitationCoder` to `public struct: Hashable`
- Expose it on `CitationConfig` instead of the typography layer
- Update sample fixtures and tests to construct configs explicitly
Closes #42
## Validation
- `xcodebuild test -scheme SwiftStreamingMarkdown -destination "platform=iOS Simulator,OS=26.4.1,name=iPhone 17" -skipMacroValidation` — all tests pass
- `xcodebuild build` on the sample app — succeeds
- Verified citation rendering visually in the sample app's multi-paragraph demo
## OSS readiness
- [x] No secrets, internal URLs, private identifiers, or product-only service names were added.
- [x] Public docs, fixtures, or notices were updated if behavior or dependencies changed.
- [x] Third-party dependency changes (adds, removes, version bumps) are intentional and reviewed. (no dependency changes)
- [x] Streaming/incomplete markdown behavior remains covered by fixtures or tests.
Output Format
Return two parts:
- Publication summary:
- Commit created/skipped (+ SHA when created)
- Branch used/created
- Push result
- PR action: created or updated
- PR URL (if available)
- Complete PR body, following the template exactly:
## Summary
<!-- What changed and why? -->
## Validation
<!-- List the checks you ran, for example: make test && make build -->
## OSS readiness
- [ ] No secrets, internal URLs, private identifiers, or product-only service names were added.
- [ ] Public docs, fixtures, or notices were updated if behavior or dependencies changed.
- [ ] Third-party dependency changes (adds, removes, version bumps) are intentional and reviewed.
- [ ] Streaming/incomplete markdown behavior remains covered by fixtures or tests.
Guardrails
- If the current branch has an open PR, always ask the user whether the new work belongs on that PR or on a new branch — never assume. See the IMPORTANT callout at the top of the workflow.
- Every PR must reference its GitHub issue in the Summary section using a
Closes #N / Fixes #N / Refs #N line. If no issue exists, create one first with gh issue create before opening the PR. The only allowed exception is when the user explicitly waives this requirement.
- Never force-push to update a PR. Do not run
git push --force or git push --force-with-lease, and do not amend, rebase, or squash commits that have already been pushed. To update a PR, always add a new commit on top. If a push is rejected as non-fast-forward, stop and ask the user — do not "resolve" it with force.
- Do not create duplicate PRs for the same head branch.
- Keep commit scope limited to intended changes; avoid unrelated files.
- Do not omit legitimate branch changes only because they were not created in the current agent session.
- Do not commit secrets, internal-only URLs, or product-confidential identifiers — this is a public OSS repo.
