github-commit

name	github-commit
description	GitHub仓库提交管理技能，用于检查、验证和提交代码到GitHub仓库。当用户需要提交代码到GitHub时使用此技能，包括：1) 检查当前Git仓库状态和远程链接，2) 验证或更新GitHub远程仓库链接，3) 审核代码更改并生成提交消息，4) 创建提交并可选推送到远程仓库。特别适用于需要确保正确提交到指定GitHub仓库的场景。

GitHub提交管理技能

概述

此技能提供完整的GitHub仓库提交工作流程，包括仓库状态检查、远程链接验证、代码审核和提交创建。确保代码正确提交到指定的GitHub仓库。

工作流程

1. 检查当前仓库状态

首先检查当前目录是否是Git仓库，以及是否已配置远程仓库链接。

触发条件：当用户需要提交代码但不确定当前仓库状态时。

操作步骤：

1. 运行 scripts/check_git_status.py 检查仓库状态
2. 显示远程仓库链接、当前分支和未提交的更改
3. 确认是否使用现有的远程仓库链接

示例用户请求：

• "检查当前仓库状态"
• "查看Git仓库的远程链接"
• "确认当前分支和更改状态"

2. 验证或更新远程仓库链接

如果远程仓库链接不存在或需要更新，允许用户验证或更新GitHub仓库链接。

触发条件：

• 当前仓库没有配置远程链接
• 用户需要更改远程仓库链接
• 远程链接无效或需要验证

操作步骤：

1. 使用 scripts/update_remote.py 验证GitHub URL格式
2. 如果远程已存在，提示用户确认是否更新
3. 添加或更新远程仓库链接
4. 测试远程连接

示例用户请求：

• "更新远程仓库链接到 https://github.com/username/repo.git"
• "添加GitHub远程仓库"
• "验证当前远程链接是否正确"

3. 审核代码并创建提交

审核代码更改，生成合适的提交消息，并创建提交。

触发条件：当用户需要提交代码更改时。

操作步骤：

1. 使用 scripts/create_commit.py 检查代码更改
2. 根据更改类型生成提交消息建议
3. 验证提交消息格式
4. 添加更改到暂存区并创建提交
5. 可选：推送到远程仓库

示例用户请求：

• "提交当前更改"
• "创建提交并推送到GitHub"
• "审核代码并生成提交"

脚本使用说明

CLI Contract

• python github-commit/scripts/check_git_status.py [path] [--history-limit N] [--json]
• python github-commit/scripts/update_remote.py <path> <remote> <url> [--json]
• python github-commit/scripts/create_commit.py <path> <message> [--push] [--remote origin] [--json]

退出码约定：

• 0: 成功
• 1: 运行时错误
• 2: 参数错误

check_git_status.py

检查Git仓库状态的脚本。

用法：

python github-commit/scripts/check_git_status.py [目录路径] [--history-limit 5] [--json]

输出：

• 仓库状态（是否是Git仓库）
• 远程仓库链接
• 当前分支
• 未提交的更改列表
• 最近提交历史

update_remote.py

更新Git远程仓库链接的脚本。

用法：

python github-commit/scripts/update_remote.py <目录> <远程名称> <GitHub URL> [--json]

示例：

python github-commit/scripts/update_remote.py . origin https://github.com/username/repo.git

功能：

• 验证GitHub URL格式
• 添加或更新远程仓库
• 测试远程连接

create_commit.py

创建Git提交的脚本。

用法：

python github-commit/scripts/create_commit.py <目录> <提交消息> [--push] [--remote origin] [--json]

示例：

# 仅创建提交
python github-commit/scripts/create_commit.py . "修复登录页面样式问题"

# 创建提交并推送
python github-commit/scripts/create_commit.py . "添加新功能模块" --push

功能：

• 验证提交消息格式
• 自动生成提交消息建议
• 添加所有更改到暂存区
• 创建提交
• 可选推送到远程仓库

完整工作流程示例

场景1：新仓库首次提交

1. 用户： "我需要提交代码到GitHub仓库 https://github.com/myuser/myproject.git"
2. 检查当前仓库状态
3. 发现没有远程链接，提示用户确认
4. 添加远程仓库链接
5. 审核代码更改
6. 生成提交消息并创建提交
7. 推送到远程仓库

场景2：更新现有仓库

1. 用户： "提交我的更改"
2. 检查当前仓库状态，显示现有远程链接
3. 确认使用现有远程链接
4. 审核代码更改
5. 生成提交消息并创建提交
6. 推送到远程仓库

场景3：更改远程仓库

1. 用户： "我想更改远程仓库到新的GitHub地址"
2. 检查当前远程链接
3. 提示用户确认更新
4. 更新远程仓库链接
5. 测试连接
6. 继续提交流程

最佳实践

提交消息规范

• 使用中文或英文描述更改内容
• 消息长度：10-200字符
• 清晰描述更改的目的
• 避免使用模糊的词语如"更新"、"修复"

远程链接验证

• 确保GitHub URL格式正确
• 测试远程连接是否正常
• 确认有访问权限

代码审核

• 检查更改的文件列表
• 确认没有意外更改
• 确保不提交敏感信息（如API密钥、密码）

错误处理

常见错误及解决方案

1. 不是Git仓库：在当前目录初始化Git仓库
2. 远程链接无效：检查URL格式和网络连接
3. 提交消息太短：提供更详细的描述
4. 没有更改可提交：确认有未提交的更改
5. 推送权限不足：检查GitHub访问权限

安全注意事项

• 不自动提交包含敏感信息的文件
• 提示用户确认远程仓库链接
• 不自动强制推送更改

资源文件

脚本文件

此技能包含以下脚本：

• scripts/check_git_status.py - Git仓库状态检查
• scripts/update_remote.py - 远程仓库链接管理
• scripts/create_commit.py - 提交创建和管理

这些脚本可以直接执行，也可以通过Claude调用。

参考文档

• references/git_workflow.md - Git工作流程完整指南
• references/commit_conventions.md - Git提交约定规范

快速参考

• assets/git_cheatsheet.md - Git命令快速参考手册

技术实现细节

脚本功能说明

1. check_git_status.py

• 输入: 可选目录路径（默认当前目录）
• 输出: JSON格式的仓库状态信息
• 功能:
  • 验证是否是Git仓库
  • 获取远程仓库信息
  • 显示当前分支状态
  • 列出未提交的更改
  • 显示最近提交历史

2. update_remote.py

• 输入: 目录路径、远程名称、GitHub URL
• 输出: 操作结果状态
• 功能:
  • 验证GitHub URL格式（支持HTTPS和SSH）
  • 检查现有远程配置
  • 交互式确认更新操作
  • 测试远程连接可用性
  • 提供详细的错误信息

3. create_commit.py

• 输入: 目录路径、提交消息、可选推送标志
• 输出: 提交操作结果
• 功能:
  • 验证提交消息格式和长度
  • 自动分析更改类型生成建议消息
  • 批量添加所有更改到暂存区
  • 创建提交并可选推送到远程
  • 提供详细的进度反馈

错误处理机制

所有脚本都包含完善的错误处理：

1. 输入验证: 检查参数有效性
2. Git操作验证: 确认Git命令执行成功
3. 网络连接测试: 验证远程仓库可达性
4. 用户确认: 重要操作前请求用户确认
5. 详细错误信息: 提供可操作的错误提示

安全特性

1. 权限检查: 不自动执行高风险操作
2. 敏感信息保护: 提示用户检查提交内容
3. 确认机制: 重要更改需要用户确认
4. 撤销支持: 提供操作撤销指导

扩展和自定义

添加新功能

可以通过修改脚本文件添加新功能：

1. 在现有脚本中添加新函数
2. 创建新的脚本文件
3. 更新SKILL.md文档

配置选项

脚本支持以下配置方式：

1. 命令行参数: 直接传递参数
2. 环境变量: 通过环境变量配置
3. 配置文件: 支持JSON/YAML配置文件

集成其他工具

可以扩展集成：

1. 代码质量工具: ESLint、Prettier等
2. 测试框架: 提交前运行测试
3. CI/CD系统: 触发自动化流程

维护和支持

版本兼容性

• Python: 3.7+
• Git: 2.20+
• 操作系统: macOS, Linux, Windows (WSL)

问题排查

常见问题解决方案：

1. 脚本权限问题: chmod +x scripts/*.py
2. Python依赖: 确保Python环境正确
3. Git配置: 检查Git用户名和邮箱设置
4. 网络连接: 验证GitHub访问权限

贡献指南

欢迎贡献改进：

1. Fork仓库并创建功能分支
2. 添加测试用例
3. 更新文档
4. 提交Pull Request

使用示例

示例1：检查Git状态并提交

# 检查当前Git状态
python github-commit/scripts/check_git_status.py .

# 创建提交（如果状态正常）
python github-commit/scripts/create_commit.py . "修复bug: 解决登录问题"

# 推送到远程仓库
python github-commit/scripts/create_commit.py . "添加新功能" --push

示例2：验证和更新远程仓库

# 验证当前远程仓库配置
python github-commit/scripts/check_git_status.py . --json

# 更新远程仓库URL
python github-commit/scripts/update_remote.py . origin https://github.com/new-org/new-repo.git

# 验证更新后的配置
python github-commit/scripts/check_git_status.py .

示例3：批量提交工作流

# 1. 检查所有更改
python github-commit/scripts/check_git_status.py . --history-limit 10

# 2. 生成有意义的提交消息
python github-commit/scripts/create_commit.py . "feat: 添加用户认证系统"

# 3. 推送到生产分支
python github-commit/scripts/create_commit.py . "发布v1.2.0" --push --remote origin

示例4：与其他技能协同工作

# 与update-readme技能协同
python update-readme/scripts/analyze_project.py .
python github-commit/scripts/create_commit.py . "docs: 更新项目文档"

# 与skill-manager协同
python skill-manager/scripts/scan_and_check.py .
python github-commit/scripts/create_commit.py . "chore: 更新技能依赖"

User-Learned Best Practices & Constraints

Auto-Generated Section: This section is maintained by skill-evolution-manager. Do not edit manually.

User Preferences

• 当导入外部Git仓库作为技能时，必须移除.git目录
• 处理子模块问题时使用git rm --cached命令移除索引记录
• 重新添加目录时应检查文件模式是否为普通文件(100644)
• 测试技能进化功能
• 提交前自动检查git状态
• 生成详细的提交消息
• 支持多行提交消息格式

Known Fixes & Workarounds

• humanizer-zh子模块问题修复流程：1) git rm --cached humanizer-zh 2) rm -rf .git 3) git add humanizer-zh/
• 确保技能目录不包含独立的Git仓库配置
• 验证evolution.json文件创建
• 修复推送时没有新更改的警告处理
• 优化错误消息的清晰度

Custom Instruction Injection

在创建提交前总是显示更改摘要，让用户确认