|
| 1 | +--- |
| 2 | +description: Commit, push, and open a PR to staging in one shot |
| 3 | +argument-hint: [optional context or scope notes] |
| 4 | +--- |
| 5 | + |
| 6 | +# Ship Command |
| 7 | + |
| 8 | +You help ship code by creating commits, pushing to the remote branch, and creating PRs in the user's voice. |
| 9 | + |
| 10 | +## Your Task |
| 11 | + |
| 12 | +When the user runs `/ship`: |
| 13 | + |
| 14 | +1. **Check git status** - See what files have changed |
| 15 | +2. **Generate a commit message** following this format: `type(scope): description` |
| 16 | + - Types: `fix`, `feat`, `improvement`, `chore` |
| 17 | + - Scope: short identifier (e.g., `undo-redo`, `api`, `ui`) |
| 18 | + - Keep it concise |
| 19 | + |
| 20 | +3. **Run lint** - Run `bun run lint` from the repo root to fix formatting issues before staging |
| 21 | + |
| 22 | +4. **Stage and commit** the changes with the generated message |
| 23 | + |
| 24 | +5. **Push to origin** using the current branch name |
| 25 | + |
| 26 | +6. **Create a PR** to staging with a description in the user's voice |
| 27 | + |
| 28 | +## Commit Message Format |
| 29 | + |
| 30 | +Based on the repo's commit history: |
| 31 | +``` |
| 32 | +fix(scope): description for bug fixes |
| 33 | +feat(scope): description for new features |
| 34 | +improvement(scope): description for enhancements |
| 35 | +chore(scope): description for maintenance |
| 36 | +``` |
| 37 | + |
| 38 | +## PR Description Format |
| 39 | + |
| 40 | +Use this exact template in the user's voice (concise, bullet points): |
| 41 | + |
| 42 | +```markdown |
| 43 | +## Summary |
| 44 | +- bullet point describing what changed |
| 45 | +- another bullet point if needed |
| 46 | + |
| 47 | +## Type of Change |
| 48 | +- [x] Bug fix (or appropriate type) |
| 49 | + |
| 50 | +## Testing |
| 51 | +Tested manually (or describe testing) |
| 52 | + |
| 53 | +## Checklist |
| 54 | +- [x] Code follows project style guidelines |
| 55 | +- [x] Self-reviewed my changes |
| 56 | +- [ ] Tests added/updated and passing |
| 57 | +- [x] No new warnings introduced |
| 58 | +- [x] I confirm that I have read and agree to the terms outlined in the [Contributor License Agreement (CLA)](./CONTRIBUTING.md#contributor-license-agreement-cla) |
| 59 | +``` |
| 60 | + |
| 61 | +## PR Creation Command |
| 62 | + |
| 63 | +Use this command structure: |
| 64 | +```bash |
| 65 | +gh pr create --base staging --title "COMMIT_MESSAGE" --body "PR_BODY" |
| 66 | +``` |
| 67 | + |
| 68 | +## Important Notes |
| 69 | + |
| 70 | +- Always confirm the commit message and PR description with the user before executing |
| 71 | +- The PR should be created against `staging` branch |
| 72 | +- Keep descriptions concise and in active voice |
| 73 | +- Match the user's previous PR style: direct, no fluff, bullet points |
| 74 | +- **DO NOT add "Co-Authored-By" lines to commits** - keep commit messages clean |
| 75 | + |
| 76 | +## User's Voice Characteristics (based on previous PRs) |
| 77 | + |
| 78 | +- Short, direct bullet points |
| 79 | +- No unnecessary explanation |
| 80 | +- "Tested manually" is acceptable for testing section |
| 81 | +- Checkboxes filled in appropriately |
| 82 | +- No screenshots section unless UI changes |
0 commit comments