🚀 Git提交信息生成器(推理版本)
这是一款由人工智能驱动的工具,它能将你的代码差异转化为清晰、有意义且附带详细推理过程的提交信息。该推理版本部署在Hugging Face上,不仅会生成提交信息,还会解释背后的思考过程,让你的提交历史更加透明和有价值。
注意:这是Git提交信息生成器的推理版本。若你想了解其他版本(如草稿链版本或标准版本),请查看我的Ollama仓库以获取更多详情。
测试版状态:此版本目前处于测试阶段,你的反馈对进一步完善它至关重要!
📦 数据集与指标
属性 |
详情 |
数据集 |
Tavernari/git-commit-message-dt |
评估指标 |
准确率 |
任务类型 |
摘要生成 |
标签 |
git、commit、message |
🚀 快速开始
输出格式
模型以结构化格式输出两个主要部分:
- 推理过程:详细分析代码差异中的更改内容以及生成提交信息的逻辑。
- 提交信息:对更改内容的简洁总结,随后是更详细的描述。
输出示例:
<reasoning>
差异显示 `WalletManagerView.swift` 文件有更改。最显著的更改是新增了一个 `@State` 变量 `monthlySpentGoal`,并对现有函数和状态变量进行了修改。`monthlySpentGoal` 现在在多个地方被使用,例如在 `onSave` 闭包和 `hasChanges` 函数中。这些更改的目的是添加一个新功能,允许用户为他们的钱包设置每月消费目标,该目标可以与其他钱包信息一起更新和保存。
更改内容包括:
- 新增 `@State` 变量 `monthlySpentGoal`。
- 更新 `onSave` 闭包以包含 `monthlySpentGoal`。
- 在 `hasChanges` 函数中使用 `monthlySpentGoal` 来判断钱包的消费目标是否发生变化。
- 新增使用 `monthlySpentGoal` 的 `WalletGoalSpentSection` 部分。
- 更新 `onSetAsMain` 函数以使用 `monthlySpentGoal`。
</reasoning>
为 WalletManagerView 添加每月消费目标功能
此提交为 `WalletManagerView` 添加了一个新的 `@State` 变量 `monthlySpentGoal`,并更新了 `onSave` 闭包和相关函数以包含和使用该变量。此功能允许用户为他们的钱包设置和保存每月消费目标,增强了钱包管理功能。
这种格式既说明了更改的原因(“为什么”),又说明了更改的内容(“是什么”),提高了信息的清晰度和上下文关联性。
💻 使用示例
基础用法
你可以通过以下两种方式与模型进行交互:
1. 网页界面
2. API 集成
使用 Hugging Face 推理 API 将模型集成到你的工作流程中。以下是 Python 示例代码:
import requests
API_URL = "https://api-inference.huggingface.co/models/Tavernari/git-commit-message"
headers = {"Authorization": "Bearer YOUR_HF_TOKEN"}
def query(payload):
response = requests.post(API_URL, headers=headers, json=payload)
return response.json()
diff = """
diff --git a/file1.py b/file1.py
index 83db48f..bf2a9a2 100644
--- a/file1.py
+++ b/file1.py
@@ -1,3 +1,4 @@
def hello():
print("Hello, world!")
+ print("Welcome to AI commit messages!")
"""
output = query({"inputs": diff})
print(output)
请将 YOUR_HF_TOKEN
替换为你的 Hugging Face API 令牌。响应将同时包含推理过程和提交信息。
高级用法
最佳实践提示
- 清晰的差异:使用小而聚焦的代码差异,以获得更准确的提交信息。
- 正确的格式:确保你的代码差异格式正确,以便模型能够正确解析。
- 输出处理:使用 API 时,根据需要解析响应,分离推理过程和提交信息。
📦 安装 git-gen-commit
(可选)
若你想在命令行中使用该功能,可以安装 git-gen-commit
脚本,它可以根据你的代码差异生成提交信息。
免责声明:git-gen-commit
脚本使用的是 Ollama API,而非 Hugging Face 模型。其结果可能与本推理版本有所不同。更多详情,请访问我的 Ollama 仓库。
安装(macOS/Linux)
运行以下命令全局安装 git-gen-commit
:
sudo sh -c 'curl -L https://gist.githubusercontent.com/Tavernari/b88680e71c281cfcdd38f46bdb164fee/raw/git-gen-commit \
-o /usr/local/bin/git-gen-commit && chmod +x /usr/local/bin/git-gen-commit'
使用方法
安装完成后,运行以下命令:
git gen-commit
这将分析你当前的代码差异,并通过 Ollama API 生成提交信息。
🤝 反馈与贡献
这是一个社区驱动的项目,你的参与对其发展至关重要!
- 反馈:请使用社区板块提供反馈。
- 支持:如果你想支持这个充满热情的项目,可以考虑进行捐赠:请我喝杯咖啡 ☕️。
⚠️ 免责声明
此工具仍在不断发展中。提交前,请仔细检查生成的提交信息的准确性。
📞 联系我们
我很乐意听取你的意见!你可以通过以下方式与我联系:
- 领英
- GitHub
- 推特
- 邮箱:victortavernari+gitcommitmessage@gmail.com
让我们携手共进,让基于人工智能的开发变得更加出色!