mcpField
1
1k-git-workflow

1k-git-workflow

github.com/onekeyhq开发2.5k70 次安装今天更新
代码仓库

关于 1k-git-workflow

面向 OneKey 贡献者的 Git 工作流技能，涵盖分支管理、提交与 PR 命名，以及推送和变基命令，也说明必需的提交前检查和项目分支规则。

主要功能

  1. 01分支创建与命名规则
  2. 02Conventional Commits 格式
  3. 03PR 标题约定
  4. 04推送与变基命令
  5. 05必需的提交前检查

适用场景

  1. 01创建功能或修复分支
  2. 02规范提交信息和 PR 标题
  3. 03评审前将分支更新至 x

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/onekeyhq/app-monorepo --skill 1k-git-workflow

安装后在 Claude Code 中输入/1k-git-workflow确认已加载。

详细介绍

OneKey Git 使用指南

分支管理

  • 主分支：x - 这是主要开发分支
  • 工作流：x → 创建功能分支 → 开发 → 创建 PR 合并回 x
  • 不要使用 onekey、master 或 main 作为基分支——始终使用 x
  • 绝对不要直接在 x 分支上工作 → 始终创建功能分支

分支命名

  • 功能分支：feat/description 或 feature/description
  • Bug 修复：fix/description
  • 重构：refactor/description

提交信息格式

使用 Conventional Commits 格式：

  • feat: - 新功能
  • fix: - Bug 修复
  • refactor: - 代码重构
  • perf: / optimize: - 性能改进
  • chore: - 构建、版本或非代码变更
  • docs: - 仅文档变更

格式：type: short description

  • 使用小写字母
  • 第一行保持在 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"

重要：

  • 绝不要提交未通过 lint 或 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

评论

支持 Markdown