1k-git-workflow

OneKey Git 使用ガイドライン

ブランチ管理

• メインブランチ：x - これが開発のメインブランチです
• ワークフロー：x → フィーチャーブランチを作成 → 開発 → x にPRを作成
• ベースブランチとして onekey、master、main は使用しないでください。必ず x を使用してください
• 絶対に x ブランチで直接作業しないでください → 必ずフィーチャーブランチを作成してください

ブランチの命名規則

• フィーチャーブランチ：feat/description または feature/description
• バグ修正：fix/description
• リファクタリング：refactor/description

コミットメッセージの形式

Conventional Commits 形式を使用します：

• feat: - 新機能
• fix: - バグ修正
• refactor: - コードのリファクタリング
• perf: / optimize: - パフォーマンスの改善
• chore: - ビルド、バージョン、またはコード以外の変更
• docs: - ドキュメントのみの変更

形式：type: short description

• 小文字を使用します
• 1行目は72文字未満にします
• 該当する場合はイシュー番号を含めます：fix: resolve login bug OK-12345

重要 - Claude Code のコミット：

• 「Generated with Claude Code」リンクを含めないでください
• 「Co-Authored-By: Claude」署名を含めないでください
• コミットメッセージは人間が書いたものと見分けがつかないようにしてください

PR の命名規則

コミットメッセージと同じ形式にします：

• feat: add dark mode support
• fix: resolve authentication timeout issue
• refactor: simplify payment processing logic

よく使う Git コマンド

フィーチャーブランチの作成

git checkout x
git pull origin x
git checkout -b feat/my-new-feature

変更のコミット

オプション 1：/commit コマンドを使用（推奨）

/commit

/commit コマンドは、コミット前チェック（yarn lint:staged と yarn tsc:staged）を自動的に実行し、適切な形式のコミットメッセージを作成します。

オプション 2：事前チェックを実行して手動でコミット

# Stage your changes
git add .

# Run pre-commit checks (MANDATORY)
yarn lint:staged
yarn tsc:staged

# If checks pass, commit
git commit -m "feat: add user profile page"

重要：

• リントまたは TypeScript のコンパイルに失敗するコードは絶対にコミットしないでください
• CLAUDE.md に記載されているとおり、コミット前チェックは必須です
• /commit コマンドはこれらのチェックを自動的に処理します

プッシュと PR の作成

git push -u origin feat/my-new-feature
# Then create PR via GitHub UI or gh CLI

最新の x へのリベース

git fetch origin
git rebase origin/x