ARTICLE DETAIL

资讯详情

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

Hindsight Agent记忆系统贡献指南:快速提交你的第一个PR

Hindsight Agent记忆系统贡献指南:快速提交你的第一个PR Hindsight Agent记忆系统贡献指南快速提交你的第一个PR【免费下载链接】hindsightHindsight: Agent Memory That Learns项目地址: https://gitcode.com/GitHub_Trending/hindsight2/hindsightHindsight 是一个让 AI Agent 真正学会而非只记住的记忆系统核心是 retain 存储、recall 检索、reflect 反思三个操作。参与它的开发你能接触到完整的 AI 记忆架构与大规模测试体系。这篇文章带你走通从克隆仓库到合并第一个 PR 的全部路径卡住时也知道去哪问。先搞清楚项目在做什么先建立心智地图你才知道自己的改动落在整个系统的哪个位置。Hindsight 解决的问题多数 Agent 记忆方案只是把对话历史塞进向量库做召回而 Hindsight 把记忆组织成世界事实、经验、observations带证据链的整合信念和 mental models背景自动重写的现成答案recall 时会并行执行语义、关键词、图谱、时间四种检索再融合重排。核心目录长什么样API 层与全部测试在 hindsight-api/入口包 hindsight-api-slim/hindsight_api/ 里api/是 FastAPI 路由alembic/是数据库迁移。记忆引擎在 engine/retain/、search/、reflect/、consolidation/、providers/各管一段管线改哪个管线就看哪个目录。多语言客户端在 hindsight-clients/Python、TypeScript、Go、RustCLI 是 Rust 写的 hindsight-cli/。hindsight-integrations/ 放 60 多个框架接入层文档站是 Docusaurus源码在 hindsight-docs/。贡献者的入口在哪根目录的 CONTRIBUTING.md 是唯一权威的贡献手册环境、测试、钩子、PR 规则都以它为准读它十分钟比读任何一篇博客都管用。第一次贡献的最短路径文档和补测试是两个几乎零风险的入口本文挑补一个回归测试作为最短路线因为它既有代码改动又能直接验证。假设你在 hindsight-api/tests/ 里发现某个已修 bug 没有对应测试。最短路线是五步从main切一个功能分支在 tests 下新建test_xxx.py模仿相邻文件的 fixture 写法conftest.py里有现成的公共夹具uv run pytest tests/test_xxx.py -xvs跑到绿跑一遍 lint开 PR。修文档同样低门槛。hindsight-docs/docs-integrations/ 里 60 篇集成文档各自独立改错别字、补环境变量说明、更新示例代码改完./scripts/dev/start-docs.sh本地起站预览即可。挑哪种取决于你更想摸代码还是文字两者都算完整的第一个 PR。日常开发循环把环境搭建、本地启动、跑测试和检查串成一条动线之后每天重复即可。从克隆到可以跑 API克隆仓库仓库地址是 https://gitcode.com/GitHub_Trending/hindsight2/hindsightgit clone https://gitcode.com/GitHub_Trending/hindsight2/hindsight cd hindsight克隆下来后别急着写代码。先跑一遍引导脚本它会补齐缺失的工具链uv、Node、Rust、从.env.example生成.env、装好 Python 和 Node 两侧依赖、预下载本地 ML 模型并配好 git 钩子./scripts/dev/setup.sh该脚本幂等随时可重跑只装依赖想跳过模型下载就加--skip-models。随后编辑.env填上HINDSIGHT_API_LLM_PROVIDER与HINDSIGHT_API_LLM_API_KEY支持 25 多家 LLM 提供商。启动、测试、检查的每日动线本地起 API 与控制面板各一条命令./scripts/dev/start-api.sh ./scripts/dev/start-control-plane.shAPI 监听 8888 端口UI 在 9999。改完代码后跑对应测试cd hindsight-api uv run pytest tests/ -xvs提交前手动过一遍检查和 pre-commit 钩子执行的内容一致cd hindsight-api uv run ruff check --fix . uv run ruff format . uv run ty check hindsight_apiTypeScript 侧控制平面、TS SDK则是eslint --fix加prettier钩子已配好时它们会随提交自动跑。质量底线评审看的不只是能不能跑还包括类型、测试和行为不变式是否都守住了。风格上三条硬要求Python 必须带类型提示遵循所在目录的既有模式不要发明新写法函数保持专注、命名直白。Python 用 Ruff 管 lint 和格式ty做类型检查TypeScript 用 ESLint 和 Prettier。scripts/hooks/ 里的钩子在每次提交并行执行两侧检查所以提交被拦下是常态修到全绿再推。测试要求改动核心管线时对应tests/下必须能复现问题或验证新行为——这个仓库 600 多个测试文件就是评审的参照标准。涉及数据库结构变更时迁移在alembic/里新增迁移要能被现有升级路径消化。发布方面一句话带过版本号提升由维护者通过 scripts/release.sh 完成并自动重新生成客户端开发中不要手动跑./scripts/generate-clients.sh。协作流程从分支到合并分支到合并的约定不多但每一环都有讲究。分支怎么起从main切功能分支命名沿用惯例feature/your-feature-name修 bug 用fix/。保持小步提交一个 PR 只做一件事。PR 里必须包含什么变更描述改了什么、为什么改一两句说清。关联的问题编号。测试怎么跑的、结果如何涉及行为的最好贴关键输出。文档同步动了用户可见行为hindsight-docs/ 里要跟着改。评审意见怎么回按条回复每条给结论接受就补提交不接受就写清理由评审者更在意你有没有思考而不是态度。被要求加测试时直接复用conftest.py的夹具别自己造一套。卡住了怎么办提问前先自检测试是不是真跑过、.env是否配好、有没有看tests/下同名功能的既有测试。提 issue 要写清四件事清晰的问题描述可复现的步骤预期行为与实际行为的对比环境信息操作系统、Python 版本、是否容器。缺了复现步骤的 issue 基本不会被优先处理。社区讨论渠道不确定的方向先在 GitHub Discussions 发起讨论再动手避免白做日常问题可以找维护者或进项目的 Slack 社区。文档站 hindsight-docs/ 里developer/目录覆盖了配置、存储、MCP 等常见坑搜一下往往比提问更快。下一步往哪走三张任务卡按你的时间预算挑一张。文档勘误卡推荐任务修正 docs-integrations/ 里任意一篇集成文档的过期配置或错别字。上手难度只需本地起文档站预览不碰代码。交付物一个合并的 PR附改动前后截图或 diff 说明。回归测试卡推荐任务给 engine/ 下你读得懂的一个模块补边界测试。上手难度要理解该模块的输入输出与conftest.py夹具。交付物新测试文件加一段说明测试意图的 PR 描述。Provider 集成卡推荐任务在 providers/ 里扩展一个新 LLM 提供商的适配。上手难度需要跟完整条 LLM 调用链包括超时、重试与结构化输出。交付物带完整单测的 PR并说明该 provider 的兼容性差异。从任务卡里挑一个切分支开始吧。跑不通任何一步按卡住了怎么办那一节的格式提问把上下文贴全。【免费下载链接】hindsightHindsight: Agent Memory That Learns项目地址: https://gitcode.com/GitHub_Trending/hindsight2/hindsight创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表