# Pr Ready

> Complete PR workflow - runs tests, linting, security scan, simplification, then commits, pushes, creates PR with comments, and optionally creates a release. Use after completing feature implementation.

- Skill: `advisely/pr-ready` (Agent Skill)
- Install (CLI): `npx skillmds@latest add advisely/pr-ready`
- Raw SKILL.md: https://api.skillmd.com/api/skills/advisely/pr-ready/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Security
- Author: advisely (https://skillmd.com/u/advisely)
- Updated: 2026-09-10
- Page: https://skillmd.com/skills/advisely/pr-ready

---


# PR Ready Workflow

Complete pre-PR checklist with automated git operations.

## Workflow Phases

### Phase 1: Quality Gate

#### Step 1: Run the Gate

```
/pipeline-quality
```

Runs the entire gate — lint, type check, build, the three-part security gate, tests, the test case matrix, local E2E, dead code, dependency audit, the parallel review fan-out, and the zero-debt and no-regression gates.

**Do not inline these checks here.** A check added to `/pipeline-quality` must take effect everywhere it is used; a duplicated list silently stops running the new check while continuing to report a pass.

### Phase 2: Documentation

#### Step 2: Documentation Check
- [ ] Code comments for complex logic (only where needed)
- [ ] README updated if API/usage changed
- [ ] CHANGELOG entry added with version
- [ ] API docs updated if endpoints changed

### Phase 3: Git Operations

#### Step 3: Stage Changes
```bash
git status
git diff --stat
git add -p  # Interactive staging (or specific files)
```

#### Step 4: Create Commit
```bash
git commit -m "$(cat <<'EOF'
feat(scope): Brief description of change

- Detail 1
- Detail 2

Co-Authored-By: Claude <noreply@anthropic.com>
EOF
)"
```

Follow conventional commits:
- `feat:` - New feature
- `fix:` - Bug fix
- `docs:` - Documentation
- `refactor:` - Code refactoring
- `test:` - Adding tests
- `chore:` - Maintenance

#### Step 5: Push to Remote
```bash
git push origin HEAD
# Or create new branch and push
git checkout -b feature/branch-name
git push -u origin feature/branch-name
```

### Phase 4: Create Pull Request

#### Step 6: Create PR with GitHub CLI
```bash
gh pr create \
  --title "feat(scope): Brief description" \
  --body "$(cat <<'EOF'
## Summary
[1-3 bullet points describing the change]

## Changes
- [List of specific changes]

## Test Plan
- [ ] Unit tests added/updated
- [ ] Integration tests pass
- [ ] Manual testing completed

## Screenshots (if UI changes)
[Add screenshots if applicable]

---
🤖 Generated with [Claude Code](https://claude.ai/code)
EOF
)"
```

#### Step 7: Add PR Comments (Optional)
```bash
# Add review comments for specific lines
gh pr comment --body "Note: This section handles edge case X"

# Request reviewers
gh pr edit --add-reviewer username1,username2
```

### Phase 5: Release (Optional)

#### Step 8: Route to the Full Release Chain

Only if the user requests a release. Do not hand-roll the version bump and tag here — route to the full chain, which carries the failsafe backup, the post-rebase gate re-run and the post-deploy verification that this phase previously lacked:

```
/pipeline-full-build-cloud      # or
/pipeline-full-build-desktop
```

## Output Format

```markdown
## PR Ready Report

### Quality Checks
| Check | Status | Details |
|-------|--------|---------|
| Tests | ✅ PASS | 47/47 passed, 92% coverage |
| Lint | ✅ PASS | 0 errors, 2 warnings (ignored) |
| Types | ✅ PASS | No type errors |
| Security | ✅ PASS | No vulnerabilities |
| Simplify + Review | ✅ PASS | Removed 12 lines; 0 blocking findings (/pipeline-quality steps 10-11) |

### Documentation
- [x] Comments adequate
- [x] README current
- [x] CHANGELOG updated

### Git Operations
- **Branch**: feature/user-profile-edit
- **Commits**: 3 new commits
- **Files changed**: 8
- **Insertions**: +247
- **Deletions**: -34

### Pull Request
- **PR URL**: https://github.com/owner/repo/pull/123
- **Title**: feat(profile): Add user profile editing with image upload
- **Reviewers**: @reviewer1, @reviewer2
- **Labels**: enhancement, needs-review

### Release (if created)
- **Version**: v1.2.3
- **Tag**: https://github.com/owner/repo/releases/tag/v1.2.3

---
✅ **PR created successfully!**
```

## User Prompts

The skill will ask for confirmation at key points:

1. **After quality checks**: "All checks passed. Proceed to commit?" (yes/no)
2. **After staging**: "These files will be committed. Proceed?" (yes/no)
3. **After PR creation**: "Create a release version?" (yes/no/version)

## Flags/Arguments

```
/pr-ready                    # Full workflow, prompts for release
/pr-ready --no-release       # Skip release step
/pr-ready --release minor    # Auto-create minor release
/pr-ready --draft            # Create draft PR
/pr-ready --reviewer @user   # Add specific reviewer
```