资讯详情

资讯详情

4 步提交你的第一个 PR:Hindsight AI 记忆系统贡献完整路径

4 步提交你的第一个 PRHindsight AI 记忆系统贡献完整路径【免费下载链接】hindsightHindsight: Agent Memory That Learns项目地址: https://gitcode.com/GitHub_Trending/hindsight2/hindsightHindsight 是一个开源 AI 智能体记忆系统它让 Agent 不重放对话历史而是通过 retain、recall、reflect 三个操作持续学习和更新知识。本文按贡献者时间线组织开源贡献流程选任务、跑项目、改代码、过评审。读完你会带走一套可直接复制的命令和一份 PR 自检清单。动手前看懂项目结构再从 Issue 挑任务这一节解决我该从哪里下手的问题。写第一行代码之前花 10 分钟摸清代码放在哪、哪类改动适合新人。仓库是一个 monorepo按职责拆成了十几个顶层目录你只需要记住四个hindsight-api-slim/hindsight_api/核心记忆引擎retain/recall/reflect 流水线、实体图谱、记忆整合consolidation都在这里hindsight-control-plane/Next.js 写的 Web 控制面板hindsight-clients/与 hindsight-integrations/Python/TypeScript/Rust/Go 四套 SDK以及 50 多个 Agent 框架集成Claude Code、Cursor、LangGraph 等hindsight-docs/docs/Docusaurus 文档站源码改动即更新官方文档。测试规模可以参考hindsight-api-slim/tests/下有 491 个测试文件。选任务时有几个比较稳的信号修文档。门槛最低改完本地起文档站就能验证是验证整套贡献流程的最短路径带完整复现步骤的 bug。仓库的 Issue 模板强制要求描述、步骤、预期与实际行为复现信息齐的 bug 才好下手给缺覆盖的模块补测试。491 个测试文件背后仍有空白区写测试不引入行为变更评审阻力小集成目录里的配置补全。hindsight-integrations/ 下每个框架一个子目录模式高度一致照着邻居写即可。选中的任务先在 Issue 里留言说明思路维护者确认方向再动手能省掉一整轮返工。️ 一条命令跑通 Hindsight 本地开发环境这一节把克隆、环境配置、装依赖、启动服务合并成一条主线全程不超过 5 分钟。在仓库根目录执行git clone https://gitcode.com/GitHub_Trending/hindsight2/hindsight cd hindsight cp .env.example .env然后编辑.env填入HINDSIGHT_API_LLM_API_KEY按需改HINDSIGHT_API_LLM_PROVIDER和HINDSIGHT_API_LLM_MODEL默认 openai 的 gpt-4o-mini。支持 OpenAI、Anthropic、Gemini、Groq、Ollama 等 25 种 provider本地模型走 ollama 也行。环境初始化交给官方脚本./scripts/dev/setup.sh它是幂等的可重复执行。脚本会自动检查并安装 uv/Python、Node、Rust 工具链安装全部 Python 与 Node 工作区依赖配置 git 钩子构建 TypeScript SDK 和 Rust CLI并预下载本地模型与分词器之后可以离线开发。网络慢或不想下载模型时加--skip-models只装依赖用--skip-build。启动服务两条命令./scripts/dev/start-api.sh ./scripts/dev/start-control-plane.shAPI 服务默认监听 8888 端口脚本会自动读取根目录的.env控制面板是独立的 Next.js 应用起完就能看到记忆库的知识视图![Hindsight 本地开发环境跑起来后的控制面板知识图谱视图](https://raw.gitcode.com/GitHub_Trending/hindsight2/hindsight/raw/30ce3b8d1139367b72092cf9dcf4116e9d1cd274/Screenshot 2026-07-02 at 17.59.51.png?utm_sourcegitcode_repo_files)文档站同理./scripts/dev/start-docs.sh一条命令。开发用的全部脚本都放在 scripts/dev/需要时可以翻。写出第一个改动并通过自检这一节解决改了代码怎么保证不坏东西。按编号走四步从main切分支命名用类型/简述例如fix/recall-timeout、docs/fix-retain-typo改动保持聚焦一个 PR 只做一件事顺手修别的留到下一个 PR本地验证。API 相关改动跑对应测试仓库的实际测试与源码在hindsight-api-slim/下cd hindsight-api-slim uv run pytest tests/test_retain.py -v提交前过一遍 lint。setup.sh已经装好 pre-commit 钩子提交时会自动执行ruff check --fix、ruff format、ty checkPython 侧和eslint --fix、prettierTypeScript 侧想提前手动跑执行./scripts/hooks/lint.sh代码风格就三条硬要求Python 必须写类型提示、沿用模块内既有模式、函数保持单一职责。另外有一个容易踩的坑如果你改了 API 端点必须执行./scripts/generate-openapi.sh重新生成 OpenAPI 规范而./scripts/generate-clients.sh不要手动跑客户端 SDK 由发布流程统一再生。提交并让 PR 描述一次过评审这一节解决推上去之后怎么被快速合并。推分支git push -u origin fix/recall-timeoutPR 描述写四件事缺一项评审就多一轮往返改了什么一两句话说清变更范围为什么改贴上关联的 Issue 编号说明动机怎么验证贴出你跑过的测试命令和结果是否影响 API动过端点就注明已重新生成 OpenAPI 规范。从仓库的 CI 配置和贡献约定反推被打回最常见的原因有这几个测试没跑全。hindsight-api-slim/tests/是全量基准至少跑受影响模块的测试再提交端点变了但 OpenAPI 规范没同步夹带无关改动格式调整、版本升级和业务逻辑混在一个 PR 里风格问题。这类问题钩子本可以拦住带着提交等于告诉维护者你跳过了自检。维护者期望的其实很简单改动聚焦、能自证正确、描述让评审不用翻代码找动机。之后发布节奏与成长路径你的第一个 PR 合并后剩下的节奏可以自己掌握。版本发布由维护者执行scripts/release.sh version完成一次发布会更新所有组件版本号、重新生成 OpenAPI 规范与 Python/TypeScript/Rust 客户端、刷新文档版本并打 tag普通贡献者不需要参与开发期改代码也不要手动触发客户端生成。反馈通道是现成的报 bug 用仓库内置的 Issue 模板它会引导你填描述、复现步骤、预期与实际行为使用问题走 Discussions仓库关闭了空白 Issue问句直接开 Issue 会被转走。成长路径可以沿着目录走从文档和补测试起步到修hindsight-api-slim/hindsight_api/里检索和整合管线的 bug再到 hindsight-integrations/ 里新增一个框架集成。涉及检索策略的改动还可以用仓库内的基准工具验证效果项目持续公开的 LongMemEval 成绩就是这套体系产出的读完之后的 3 步行动清单打开 Issue 列表按上面四个信号挑一个任务并留言认领复制第二节三条命令把本地环境跑起来确认控制面板能打开建分支做最小改动跑通测试和./scripts/hooks/lint.sh后提交 PR。第一个 PR 不需要解决什么大问题它的作用是把选任务、跑起来、提交、评审这条链路走完一次。走完之后后面的每次贡献都只是重复这个循环。【免费下载链接】hindsightHindsight: Agent Memory That Learns项目地址: https://gitcode.com/GitHub_Trending/hindsight2/hindsight创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
觉得有用,分享给同行:

为您的企业打造数字门面

稳重轻奢商务风格,端正雅致视觉,长效耐看不易过时。

立即咨询 →