1k-git-workflow

OneKey 开发的 Git 工作流与规范。在创建分支、提交代码或发起 PR 时务必遵循。该规范适用于 Git 操作、分支管理、提交记录、PR 提交、拉取请求、合并操作以及工作流流程。

SKILL.md

--- frontmatter

name: 1k-git-workflow
description: Git workflow and conventions for OneKey development. Use when creating branches, committing code, or creating PRs. Triggers on git, branch, commit, PR, pull request, merge, workflow.
allowed-tools: Bash, Read

OneKey Git Usage Guidelines

Branch Management

•Main branch: main - This is the primary development branch
•Workflow: main → create feature branch → develop → PR back to main
•NEVER work directly on the main branch → ALWAYS create feature branches

Branch Naming

•Feature branches: feat/description or feature/description
•Bug fixes: fix/description
•Refactoring: refactor/description

Commit Message Format

Use Conventional Commits format:

•feat: - New features
•fix: - Bug fixes
•refactor: - Code refactoring
•perf: / optimize: - Performance improvements
•chore: - Build, version, or non-code changes
•docs: - Documentation only

Format: type: short description

•Use lowercase
•Keep first line under 72 characters
•Include issue number if applicable: fix: resolve login bug OK-12345

IMPORTANT - Claude Code commits:

•Do NOT include "Generated with Claude Code" link
•Do NOT include "Co-Authored-By: Claude" signature
•Commit message should be indistinguishable from human-written commits

PR Naming Convention

Follow the same format as commit messages:

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

Common Git Commands

Creating a Feature Branch

bash

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

Committing Changes

bash

git add .
git commit -m "feat: add user profile page"

Pushing and Creating PR

bash

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

Rebasing on Latest main

bash

git fetch origin
git rebase origin/main