Hindsight AI 记忆系统贡献指南开源新人从零到提交 PR 的完整实践教程【免费下载链接】hindsightHindsight: Agent Memory That Learns项目地址: https://gitcode.com/GitHub_Trending/hindsight2/hindsightHindsight 是一个开源的 AI 代理记忆系统它让智能体不只是记住对话历史还能持续学习、把短期信息沉淀为长期记忆。本指南带你走通从搭建环境到提交 PR 的完整流程读完本文你就能在本地把项目跑起来完成一次启动 → 测试 → 自检的标准开发循环并知道自己该从哪里找任务下手。 上手第一步如何搭建开发环境获取代码git clone https://gitcode.com/GitHub_Trending/hindsight2/hindsight cd hindsight配置环境变量与密钥cp .env.example .env然后把.env里 LLM 的三项填好HINDSIGHT_API_LLM_PROVIDER默认openai、HINDSIGHT_API_LLM_API_KEY、HINDSIGHT_API_LLM_MODEL。这个模板里有大段注释照着注释换成你自己的提供商即可如果手上没有 API Key也可以选ollama、lmstudio这类本地方案。安装依赖并本地启动./scripts/dev/setup.sh这是项目提供的一步式初始化脚本幂等设计、可以反复重跑它会自动补齐缺失的工具链uv/Python、Node、Rust、从模板生成.env、配置 git 钩子、装好所有 Python 与 Node 工作区依赖并预下载本地 ML 模型让 API 离线也能工作。想跳过模型下载加--skip-models顺带构建文档站加--with-docs。完成后启动三个服务按需选./scripts/dev/start-api.sh # 记忆 API ./scripts/dev/start-control-plane.sh # Web 控制面板 ./scripts/dev/start-docs.sh # 本地文档站 日常开发循环运行、测试与提交前自检提交前必跑的测试命令cd hindsight-api uv run pytest tests/测试套件是合并前的最低门槛——PR 提交后 CI 也会自动跑同一套流程本地先过一遍能省很多往返时间。代码检查格式化、静态检查与类型检查./scripts/hooks/lint.sh一条命令并行跑完所有检查Python 侧是ruff check --fixruff formatty checkTypeScript 侧是eslint --fixprettier。不想每次手动执行的话运行一次./scripts/setup-hooks.sh之后每次提交都会自动触发同样的检查。提交代码前的清单uv run pytest tests/全绿./scripts/hooks/lint.sh无失败项风格与现有代码一致Python 带类型提示、函数保持单一职责、命名表达意图。 代码提交规范从功能分支到 PR分支怎么开从main拉新分支命名用feature/你的功能名这类前缀形式一个分支只解决一件事。PR 必须包含什么变更说明写清楚解决了什么问题、实现了什么行为而不只是改了一些代码测试新行为要有对应测试用例且本地全量测试通过文档同步涉及行为、配置变化时把 hindsight-docs/ 下的对应文档一起改掉。评审不通过怎么办提交后 CI 会自动跑测试与 lint。红了就去看失败日志本地复现、修好、再推一个修复提交即可不用重开 PR。对方案拿不准时先在 Discussions 里和维护者对齐再动手比改完被整体打回要快得多。⚠️ 常见坑与排错API 起不来、日志一片报错先查.env里的HINDSIGHT_API_LLM_API_KEY是否填错、过期这是新手最高频的故障点。Node 相关依赖装不上工作区要求 Node 20 及以上CI 在 20/22 上构建先用node -v确认版本。uv.lock被意外改动lint 流程用的是 frozen 同步故意不去重写锁文件如果你真的改了依赖请显式更新 lockfile 后再跑检查。手贱跑了./scripts/generate-clients.sh客户端 SDK 只在正式发布时由scripts/release.sh重新生成开发期改版本号不需要也请不要手动跑生成脚本。首次启动慢或模型缺失重跑./scripts/dev/setup.sh --force重建产物正常情况模型已被预下载API 可离线运行。 如何找到适合自己的任务任务来源主要有两处仓库的 Issues内置 bug report 与 feature request 两种模板提交 bug 时需包含问题描述、复现步骤、预期与实际行为、环境信息以及社区 Discussions。按投入程度分三档新手友好润色或补全 hindsight-docs/ 里的文档、为现有功能补测试用例、修复报错明确的小 bug进阶实现新 API、优化检索或整合链路上的性能、为新 LLM 提供商适配高阶参与hindsight-api-slim/hindsight_api/engine/下的核心记忆引擎与整合算法、维护多语言客户端 SDK。 从今天开始选任务翻一遍 Issues挑一个标注清晰、与你技能匹配的小问题搭环境克隆仓库后跑通./scripts/dev/setup.sh起服务验证./scripts/dev/start-api.sh确认 API 能正常响应动手实现按开分支 → 改代码 → 跑测试 → 过 lint的循环推进提交 PR变更说明、测试结果、文档更新一样不少CI 红了就推修复提交。开源最好的入门时机就是现在——你的第一个 PR 不需要很大一处文档勘误同样值得提交跑通流程本身就是最大的收获。【免费下载链接】hindsightHindsight: Agent Memory That Learns项目地址: https://gitcode.com/GitHub_Trending/hindsight2/hindsight创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
Hindsight AI 记忆系统贡献指南：开源新人从零到提交 PR 的完整实践教程
Hindsight AI 记忆系统贡献指南开源新人从零到提交 PR 的完整实践教程【免费下载链接】hindsightHindsight: Agent Memory That Learns项目地址: https://gitcode.com/GitHub_Trending/hindsight2/hindsightHindsight 是一个开源的 AI 代理记忆系统它让智能体不只是记住对话历史还能持续学习、把短期信息沉淀为长期记忆。本指南带你走通从搭建环境到提交 PR 的完整流程读完本文你就能在本地把项目跑起来完成一次启动 → 测试 → 自检的标准开发循环并知道自己该从哪里找任务下手。 上手第一步如何搭建开发环境获取代码git clone https://gitcode.com/GitHub_Trending/hindsight2/hindsight cd hindsight配置环境变量与密钥cp .env.example .env然后把.env里 LLM 的三项填好HINDSIGHT_API_LLM_PROVIDER默认openai、HINDSIGHT_API_LLM_API_KEY、HINDSIGHT_API_LLM_MODEL。这个模板里有大段注释照着注释换成你自己的提供商即可如果手上没有 API Key也可以选ollama、lmstudio这类本地方案。安装依赖并本地启动./scripts/dev/setup.sh这是项目提供的一步式初始化脚本幂等设计、可以反复重跑它会自动补齐缺失的工具链uv/Python、Node、Rust、从模板生成.env、配置 git 钩子、装好所有 Python 与 Node 工作区依赖并预下载本地 ML 模型让 API 离线也能工作。想跳过模型下载加--skip-models顺带构建文档站加--with-docs。完成后启动三个服务按需选./scripts/dev/start-api.sh # 记忆 API ./scripts/dev/start-control-plane.sh # Web 控制面板 ./scripts/dev/start-docs.sh # 本地文档站 日常开发循环运行、测试与提交前自检提交前必跑的测试命令cd hindsight-api uv run pytest tests/测试套件是合并前的最低门槛——PR 提交后 CI 也会自动跑同一套流程本地先过一遍能省很多往返时间。代码检查格式化、静态检查与类型检查./scripts/hooks/lint.sh一条命令并行跑完所有检查Python 侧是ruff check --fixruff formatty checkTypeScript 侧是eslint --fixprettier。不想每次手动执行的话运行一次./scripts/setup-hooks.sh之后每次提交都会自动触发同样的检查。提交代码前的清单uv run pytest tests/全绿./scripts/hooks/lint.sh无失败项风格与现有代码一致Python 带类型提示、函数保持单一职责、命名表达意图。 代码提交规范从功能分支到 PR分支怎么开从main拉新分支命名用feature/你的功能名这类前缀形式一个分支只解决一件事。PR 必须包含什么变更说明写清楚解决了什么问题、实现了什么行为而不只是改了一些代码测试新行为要有对应测试用例且本地全量测试通过文档同步涉及行为、配置变化时把 hindsight-docs/ 下的对应文档一起改掉。评审不通过怎么办提交后 CI 会自动跑测试与 lint。红了就去看失败日志本地复现、修好、再推一个修复提交即可不用重开 PR。对方案拿不准时先在 Discussions 里和维护者对齐再动手比改完被整体打回要快得多。⚠️ 常见坑与排错API 起不来、日志一片报错先查.env里的HINDSIGHT_API_LLM_API_KEY是否填错、过期这是新手最高频的故障点。Node 相关依赖装不上工作区要求 Node 20 及以上CI 在 20/22 上构建先用node -v确认版本。uv.lock被意外改动lint 流程用的是 frozen 同步故意不去重写锁文件如果你真的改了依赖请显式更新 lockfile 后再跑检查。手贱跑了./scripts/generate-clients.sh客户端 SDK 只在正式发布时由scripts/release.sh重新生成开发期改版本号不需要也请不要手动跑生成脚本。首次启动慢或模型缺失重跑./scripts/dev/setup.sh --force重建产物正常情况模型已被预下载API 可离线运行。 如何找到适合自己的任务任务来源主要有两处仓库的 Issues内置 bug report 与 feature request 两种模板提交 bug 时需包含问题描述、复现步骤、预期与实际行为、环境信息以及社区 Discussions。按投入程度分三档新手友好润色或补全 hindsight-docs/ 里的文档、为现有功能补测试用例、修复报错明确的小 bug进阶实现新 API、优化检索或整合链路上的性能、为新 LLM 提供商适配高阶参与hindsight-api-slim/hindsight_api/engine/下的核心记忆引擎与整合算法、维护多语言客户端 SDK。 从今天开始选任务翻一遍 Issues挑一个标注清晰、与你技能匹配的小问题搭环境克隆仓库后跑通./scripts/dev/setup.sh起服务验证./scripts/dev/start-api.sh确认 API 能正常响应动手实现按开分支 → 改代码 → 跑测试 → 过 lint的循环推进提交 PR变更说明、测试结果、文档更新一样不少CI 红了就推修复提交。开源最好的入门时机就是现在——你的第一个 PR 不需要很大一处文档勘误同样值得提交跑通流程本身就是最大的收获。【免费下载链接】hindsightHindsight: Agent Memory That Learns项目地址: https://gitcode.com/GitHub_Trending/hindsight2/hindsight创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考