shipping-changes

Category: Development & Coding | Uploader: wnzzer | Downloads: 0 | Version: v1.0（Latest）

Use when implementation work in the rank-analysis project is finished and the changes need to ship — running CODE_QUALITY.md checks, making a Conventional-Commits commit on a feature branch, and opening a PR via gh.

Changelog: Source: GitHub https://github.com/wnzzer/rank-analysis

Directory Structure

Current level: tree/main/.claude/skills/shipping-changes/

📄 SKILL.md 4.8 KB

SKILL.md

---
name: shipping-changes
description: Use when implementation work in the rank-analysis project is finished and the changes need to ship — running CODE_QUALITY.md checks, making a Conventional-Commits commit on a feature branch, and opening a PR via gh.
---

# Shipping Changes (rank-analysis)

## Overview

Standardize the post-implementation flow for this repo so nothing ships without lint / format / typecheck / clippy passing, and every PR follows `CONTRIBUTING.md`. This skill is the single source of truth for the "我写完了，怎么提交" question.

**Rule of thumb:** never commit on `main`, never skip `npm run check`, never `git add -A` without reading `git status` first.

## When to Use

- A feature/bugfix is implemented and you want to ship it.
- Returning to a dirty working tree and need to wrap it up cleanly.
- About to run `git commit` or `gh pr create` in this repo.

**Skip when:**
- WIP / experiment you don't intend to merge.
- Doc-only edits outside `lol-record-analysis-tauri/` (still commit, but quality steps are no-ops).

## Workflow

### 1. Snapshot the working tree

```bash
git status
git diff
git log --oneline -5
```

Decide the commit type from the diff (see §3). If still on `main`, branch first:

```bash
git switch -c <type>/<short-kebab-summary>
```

Branch name examples: `feat/match-export`, `fix/lcu-reconnect`, `refactor/automation-manager`.

### 2. Quality gate — CODE_QUALITY.md

Run from `lol-record-analysis-tauri/`:

```bash
npm run check        # = format + lint + typecheck + cargo fmt --check + cargo clippy -Dwarnings
npm run test         # vitest
cd src-tauri && cargo test && cd ..
```

`npm run check` is the canonical gate. If it fails:
- **Fix the root cause.** Don't disable the rule, don't `--no-verify`, don't add `// eslint-disable` unless the rule is genuinely wrong for the case.
- Re-run `npm run check` until clean. Then re-run `git status` — formatters may have rewritten files.

For UI changes, also `npm run tauri dev` and exercise the feature in the app. Type-check passing ≠ feature works.

### 3. Commit — Conventional Commits

Format: `<type>: <short imperative summary>` (Chinese summary OK; matches existing log).

| type | use for |
|------|---------|
| `feat` | new user-visible capability |
| `fix` | bug fix |
| `refactor` | internal change, no behavior change |
| `perf` | performance improvement |
| `style` | formatting only (prettier/cargo fmt) |
| `docs` | docs / comments |
| `test` | tests only |
| `chore` | build, deps, tooling, version bumps |

Stage files **explicitly by name** (never `git add -A` — it sweeps in `.env`, screenshots, untracked agent dirs):

```bash
git add lol-record-analysis-tauri/src/components/Foo.vue \
        lol-record-analysis-tauri/src-tauri/src/command/foo.rs
git commit -m "$(cat <<'EOF'
feat: 一句话说明做了什么以及为什么

可选的正文，解释非显然的取舍。
EOF
)"
```

Never `--amend` a pushed commit. Never `--no-verify`. If a hook fails, fix the underlying issue and create a NEW commit.

### 4. Push and open PR

```bash
git push -u origin HEAD
gh pr create --title "<type>: <summary>" --body "$(cat <<'EOF'
## Summary
- bullet 1
- bullet 2

## Test plan
- [ ] `npm run check` passes
- [ ] `npm run test` passes
- [ ] `cargo test` passes
- [ ] Manual: <what you exercised in the app>
EOF
)"
```

Print the returned PR URL back to the user.

## Quick Reference

| Step | Command |
|------|---------|
| Quality gate | `cd lol-record-analysis-tauri && npm run check` |
| Frontend tests | `npm run test` |
| Rust tests | `cd src-tauri && cargo test` |
| Branch | `git switch -c <type>/<slug>` |
| Commit | `git commit -m "<type>: ..."` (HEREDOC for body) |
| Push | `git push -u origin HEAD` |
| PR | `gh pr create --title ... --body ...` |

## Common Mistakes

| Mistake | Fix |
|---------|-----|
| Committing on `main` | `git switch -c <branch>`; `git reset --soft origin/main` only if nothing pushed |
| `git add -A` sweeping `.claude/`, `.env`, build artifacts | Stage by explicit path |
| Skipping `npm run check` because "it's a small change" | Run it. Formatters reorder imports; typecheck catches drift |
| `--no-verify` to bypass a failing hook | Fix the hook's complaint; re-stage; new commit |
| `git commit --amend` after push | Make a fixup commit instead |
| Disabling clippy/eslint rule to silence a warning | Fix the code; only suppress with a comment explaining why |
| Vague commit (`fix: bug`, `chore: update`) | Say what changed and why in one sentence |
| Forgetting Rust side when only frontend touched (or vice versa) | `npm run check` runs both; trust the gate |

## Red Flags — STOP

- "I'll just push and fix CI" → run `npm run check` locally first, it's faster than CI
- "Hook is being annoying, --no-verify" → no
- "The diff is too big to read, `git add -A`" → split the commit instead
- "I'll amend the pushed commit" → fixup commit instead

Comments 0

Latest | Hot

Please login before commenting.

Loading comments...

shipping-changes

Directory Structure

SKILL.md

Report

Notice