vellum-pr-readiness

Solid

Prepare Vellum Assistant branches for review by checking git hygiene, PR scope, tests, docs, migrations, Linear linking, and companion repo needs. Use before creating a pull request, splitting work into PRs, or asking whether a branch is ready.

AI & Automation 648 stars 94 forks Updated today MIT

Install

View on GitHub

Quality Score: 86/100

Stars 20%
94
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
92
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 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 u...

Details

Author
vellum-ai
Repository
vellum-ai/vellum-assistant
Created
4 months ago
Last Updated
today
Language
TypeScript
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category