ARTICLE DETAIL

资讯详情

深耕网站建设与运营推广的一线实战洞察。

claude-tap开发者贡献指南:如何为AI编程代理追踪工具提交第一个PR?完整流程

claude-tap开发者贡献指南:如何为AI编程代理追踪工具提交第一个PR?完整流程 claude-tap开发者贡献指南如何为AI编程代理追踪工具提交第一个PR完整流程【免费下载链接】claude-tapIntercept and inspect Coding Agent API traffic from Claude Code, Codex CLI, Gemini CLI, Cursor CLI, OpenCode, Kimi/Kimi Code, Pi, and Hermes in a local trace viewer.项目地址: https://gitcode.com/gh_mirrors/cl/claude-tapclaude-tap是一款本地 AI 编程代理 API 追踪工具可拦截并可视化 Claude Code、Codex CLI、Gemini CLI、Cursor CLI 等代理的真实 API 流量。本文将带你从搭建开发环境、跑本地检查到提交一个高质量的 Pull Request完整走完为 claude-tap 贡献代码的第一站。 一分钟认识 claude-tapclaude-tap 的本质是一个「透明反向/正向代理 本地追踪查看器」你通过它启动 AI 编码代理它负责拦截每一轮请求记录系统提示词、对话历史、工具调用、Token 用量并在浏览器中提供实时查看器与 HTML 导出。理解了这条数据链路你就知道贡献可以发生在哪些环节——代理捕获claude_tap/proxy.py、claude_tap/upstream.py、追踪存储claude_tap/trace_store.py、查看器前端claude_tap/viewer_assets/。官方项目文档从 CONTRIBUTING.md 开始贡献前建议通读一遍。 第一步快速搭建 claude-tap 本地开发环境整个环境搭建只有 3 条命令核心依赖管理工具是 uv 配套的uvPython 3.11git clone https://gitcode.com/gh_mirrors/cl/claude-tap cd claude-tap uv sync --extra dev验证安装成功uv run python -m claude_tap --help强烈建议首次 clone 后启用项目自带的 pre-commit 钩子它会在每次 commit 前自动运行 lint 检查帮你提前拦住格式问题见 AGENTS.md 的 Pre-commit Hook 章节git config core.hooksPath .githooks 第二步提交前必跑的 3 个本地检查claude-tap 的 CI 门槛并不神秘就是下面这组命令来自 CONTRIBUTING.md 的 Local Checks 章节检查项命令作用Lintuv run --extra dev ruff check .代码规范检查格式uv run --extra dev ruff format --check .格式一致性检查单测uv run --extra dev pytest tests/ -x --timeout60全量单元/集成测试针对特定改动还有两类可选检查查看器/浏览器相关改动先安装浏览器再跑 Playwright 测试uv run playwright install chromium uv run --extra dev pytest tests/test_nav_browser.py tests/test_responses_browser.py -x --timeout60真实端到端测试需要可用的 Claude CLI 账号默认跳过、显式开启uv run --extra dev pytest tests/e2e/ --run-real-e2e --timeout300用例覆盖单轮对话、多轮记忆、工具调用、API Key 脱敏等场景详细说明见 tests/e2e/README.md。 第三步如何写出一份会被合并的 PR打开一个 PR 之前scripts/check_pr_policy.py 和 scripts/check_pr.sh 代表了这个项目的自动审查标准对照它们准备 PR 描述几乎能一次通过标题与正文结构化正文需要包含Summary问题与用户可见的行为变化和Validation你运行过的命令及结果等章节。一个 PR 只解决一件事不要把重构和功能混在同一 PR 里每个 commit 也保持单一关注点。行为变化必须配测试新增或更新tests/下的用例且断言要能真正拦住回归。UI 改动必须带真实截图证据要求使用.traces/中的真实 trace 数据禁止合成 mock 截图。下面这张请求 Diff 界面就是典型的值得截图的 UI 功能脱敏红线严禁在 Issue/PR 中粘贴私有提示词、API Key、auth token 或未脱敏的.traces/输出——策略脚本会用正则直接拦截sk-...、Bearer eyJ...等密钥模式。️ 第四步同步更新文档与 Changelogclaude-tap 对文档有一致性要求提交时容易漏掉这里单列出来双语文档必须同步面向用户的文档需要中英文双份改 README.md 就要同时改 README_zh.mddocs/guides/下的英文指南要配套*.zh.md文件如 agent-trace-viewer.md 与 agent-trace-viewer.zh.md。新增客户端支持记得更新支持矩阵 docs/support-matrix.md中文版为 docs/support-matrix.zh.md。更新 CHANGELOG用户可见的行为变化请写入 CHANGELOG.md 的## [Unreleased]分区。版本与依赖Python 版本要求与依赖声明集中在 pyproject.toml其中 L74-L90 定义了 pytest 的测试标记如real_e2e理解它有助于写对测试用例。 给第一次贡献者的 5 条实战建议从小改动入手文档错别字、README 补充、单个函数的 bug 修复都是很好的首 PR项目明确欢迎小而聚焦的 PR。先开 Issue 再动手行为变更、功能请求先开 Issue 讨论只有显而易见的修复可以直接提 PR。本地全绿再推送三条检查命令全部通过后git add→commit→push不要留下只有本地存在的工作。读一下规则入口外部贡献者只需 CONTRIBUTING.md而 AGENTS.md 中的硬性规则英文代码注释、commit 单一职责等也能帮你理解 reviewer 的关注点。安全漏洞私聊维护者不要在公开 Issue 中披露安全细节参见 CONTRIBUTING.md 的 Reporting Security Issues 章节。️ 关键文件速查表文件/目录用途CONTRIBUTING.md官方贡献流程与 PR 清单AGENTS.md维护者规则与硬性规范入口claude_tap/proxy.py代理拦截与录制核心claude_tap/trace_store.py追踪会话存储claude_tap/viewer_assets/查看器前端 JS/CSS 资源tests/单元与集成测试60 测试文件tests/e2e/README.md真实 E2E 测试指南scripts/check_pr.shPR 合并就绪检查脚本CHANGELOG.md版本变更记录现在你已经掌握了为 claude-tap 这个 AI 编程代理追踪工具贡献代码的完整路径搭建环境 → 本地检查 → 结构化 PR → 同步文档。打开一个 Issue跑通第一条命令你的第一个 PR 就离合并很近了 【免费下载链接】claude-tapIntercept and inspect Coding Agent API traffic from Claude Code, Codex CLI, Gemini CLI, Cursor CLI, OpenCode, Kimi/Kimi Code, Pi, and Hermes in a local trace viewer.项目地址: https://gitcode.com/gh_mirrors/cl/claude-tap创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表