vellum-pr-readiness
The vellum-pr-readiness skill validates branches before pull request creation by checking git hygiene, code scope, required documentation and migrations, Linear issue linking conventions, and test coverage. Use this skill when preparing a branch for review, deciding whether to split work across multiple PRs, or determining overall branch readiness for submission.
git clone --depth 1 https://github.com/vellum-ai/vellum-assistant /tmp/vellum-pr-readiness && cp -r /tmp/vellum-pr-readiness/.cursor/skills/vellum-pr-readiness ~/.claude/skills/vellum-pr-readinessSKILL.md
# Vellum PR Readiness ## Goal Confirm the branch is reviewable, scoped, and verified before opening a PR. Prefer surfacing blockers over polishing summaries. ## Checklist 1. Inspect `git status` and identify unrelated changes, generated artifacts, deleted files, and untracked files. 2. Inspect staged and unstaged diffs before recommending a commit or PR. 3. Check for secrets: - Do not commit `.env`, credentials, tokens, private keys, or local workspace data. - `.env.example` is allowed only for placeholder values. 4. Check scope: - If the branch is too large, suggest splitting it into smaller, reviewable PR branches. - Separate unrelated UI, backend, migration, and infra changes when practical. 5. Check required follow-ups: - Migration needed for persisted data or workspace format changes. - Docs needed for significant architecture, service, or data-flow changes. - Companion `vellum-assistant-platform` PR needed for platform-affecting contracts or new feature flags. 6. Check Linear conventions: - Branch, commit body, and PR body should include the Linear issue ID when one exists. - Use `Closes JARVIS-123` for single final PRs. - Use `Part of JARVIS-123` for intermediate PRs in multi-PR plans. 7. Check verification: - Focused tests ran for changed behavior. - Typecheck ran when exported contracts or cross-package types changed. - Any skipped tests are explicitly called out. ## PR Body Template Use this compact structure unless the user asks for another format: ```markdown ## Summary - ... ## Test Plan - ... ## Risk - ... ``` Mention migrations, feature flags, rollout state, and companion PRs when relevant. ## Human Attention Comments For non-routine changes, leave a PR comment calling out review focus and risk level. Skip this for routine low-risk changes.
>
>
>
>
Check Vellum Assistant architecture and package boundaries. Use when editing imports, moving code, adding endpoints, touching assistant/gateway/client/skill boundaries, or reviewing architecture-sensitive changes.
Review Vellum Assistant code changes for correctness, repo-specific quality rules, security risks, and missing validation. Use when reviewing diffs, preparing a PR, finishing implementation work, or when the user asks for a code review, quality pass, or pre-merge check in this repository.
Guide Vellum Assistant feature flag changes and rollout hygiene. Use when adding, editing, reviewing, or documenting assistant feature flags, rollout-gated behavior, or platform flag follow-up work.
Validate Vellum Assistant database and workspace migrations. Use when adding, editing, reviewing, or testing migrations, release-note migrations, persisted schemas, workspace file formats, or data backfills.