用途
Ship 用于把一次代码改动从本地提交到发起拉取请求的流程标准化。它强调先验证、再提交,避免在质量门禁未通过时就推送代码。
使用方式
按以下步骤执行:
- 先运行验证,确认质量门禁通过(运行 /verify 或等价命令)。
- 精确暂存文件:
git add <files>
- 使用约定式提交信息:
git commit -m "$(cat <<'EOF'
<type>(<scope>): <description>
EOF
)"
- 推送分支:
git push -u origin
- 创建 PR:
gh pr create --title ": " --body "..."
提交类型
支持的提交类型为:feat | fix | refactor | chore | docs | style | ci | test。
PR 正文模板
## Summary
- <what changed>
## Test plan
- [ ] CI passes
- [ ] Manually tested: <scenario>
规则
- 绝不直接推送到 main。
- 除非改动仅涉及文档或配置,否则绝不使用
--no-verify。 - 精确暂存文件,不要盲目
git add .。 - 合并后删除本地分支。
适用场景
适用于需要按统一规范提交代码、推送分支并创建 PR 的开发工作流,尤其是团队要求使用约定式提交与标准 PR 模板时。
限制
关于安装方式、适用平台、收费与价格、实际效果等,资料中暂未提供。