logo
0
4
WeChat Login

使用方法指南#8

Open
created 2 months ago
Edit

为了方便用户快速上手使用 Gemini Extension for CNB,需要整理并收录一份详细的使用方法文档。

主要内容应包括:

  1. 安装指南:如何通过远程仓库 URL 安装扩展。
  2. 环境配置:如何配置 CNB_API_TOKEN 环境变量。
  3. 命令说明:详细列出 /cnb:bug, /cnb:checkout, /cnb:feat, /cnb:review 等命令的作用及参数说明。
  4. 最佳实践:如何在日常开发流中高效使用这些命令。

Created by GEMINI

changed title
文档:整理并收录插件使用方法指南
使用方法指南
added labels
documentation
pinned this issue
Creator

安装与更新方法

1. 安装扩展
在终端执行以下命令:

gemini extension install https://cnb.cool/xbotter/gemini-extension.git

2. 更新扩展
如果您已经安装,可以通过以下命令更新到最新版本:

gemini extension update cnb

Created by GEMINI

Creator

命令说明:/cnb:bug

作用
将当前对话上下文(包括错误日志、环境信息、代码片段等)整理并自动提交为一条新的 CNB Issue。

使用方法
在对话中输入 /cnb:bug。Gemini 会根据当前讨论的内容:

  1. 分析并提取问题详情、复现步骤及环境上下文。
  2. 自动确认或询问目标仓库。
  3. 构建结构化的 Issue 标题和描述。
  4. 调用 API 完成创建并返回链接。

Created by GEMINI

Creator

命令说明:/cnb:feat

作用
将当前对话中的想法、功能请求或改进建议整理并自动提交为一条新的 CNB Issue。

使用方法
在对话中输入 /cnb:feat。Gemini 会:

  1. 分析并提取需求详情、使用场景及预期价值。
  2. 自动确认或询问目标仓库。
  3. 构建清晰的 Issue 标题和详细描述,并尝试添加 enhancementfeature 等标签。
  4. 调用 API 完成创建并返回链接。

Created by GEMINI

Creator

命令说明:/cnb:checkout

作用
根据指定的 Issue ID 自动化完成开发环境的准备工作。它会拉取远程 Issue 详情,自动创建并切换到对应的本地 Git 分支,并将 Issue 全文(含评论)保存为本地 Markdown 文件作为开发参考。

使用方法
在对话中输入 /cnb:checkout #ID(例如 /cnb:checkout #8)。Gemini 会执行以下自动化流程:

  1. 获取信息:从 CNB 平台抓取该 Issue 的标题、描述及所有历史评论。
  2. 创建分支:基于 Issue ID 和标题生成规范的分支名(如 issue/8-usage-guide),并从远程主分支(如 main)切出。
  3. 保存上下文:在项目根目录生成 .cnb-issue.md 文件,完整记录 Issue 详情。
  4. 自动配置:自动检查并将 .cnb-issue.md 添加到 .gitignore 中,确保参考文件不会被误提交。

Created by GEMINI

Creator

命令说明:/cnb:review

作用
帮助用户审查指定的合并请求(Pull Request),查看代码变更差异,并自动提交审查意见。

使用方法
在对话中输入 /cnb:review #PR_ID(例如 /cnb:review #1)。Gemini 会执行以下流程:

  1. 获取 PR 详情:解析 PR 编号并从 CNB 平台获取详细信息,包括源分支和目标分支。
  2. 分析变更:自动拉取最新代码,使用 git diff 对比源分支与目标分支的差异。
  3. 生成评论:根据差异分析结果或用户提供的具体反馈,构建专业的审查意见。
  4. 提交反馈:将审查意见自动发布到该 Pull Request 的评论区,并附带签名。

Created by GEMINI

docs: add issue #8 link to README
docs: add usage guide and link issue #8 (#9)
Assignee
None yet
Label
documentation
Priority
None yet
Time period
-
Property
Add custom properties to record and label key information
Participant