PkuClaw
开发者指南

参与贡献

如何为 PkuClaw 提交改动、补充文档和检查 PR。

欢迎贡献 PkuClaw。当前项目仍处于快速演进阶段,贡献时请优先保持架构边界清晰和 runtime 行为可审计。

贡献类型

  • 修复 runtime loader、prompt builder、outbox queue 等基础设施问题;
  • 补充课程/学习任务相关 skill;
  • 改进飞书等 channel adapter;
  • 完善安装、配置和开发者文档;
  • 增加测试覆盖。

PR 前检查

python -m compileall pkuclaw scripts
python -m unittest discover

如果修改了文档站:

cd docs-site
npm run build

文档规范

  • 用户安装和配置写在文档站中。
  • runtime 文件格式变化同步更新文档站中的配置参考、Runtime 设计和 Skill Catalog 页面。
  • 不要把密钥、token、真实用户 ID、完整私有路径写入文档。
  • 文档示例中的通知目标统一使用 ou_xxxcli_xxx 等占位符。

代码规范

  • 新 runtime loader 放 pkuclaw/runtime/
  • 新 provider 放 pkuclaw/agents/providers/
  • 新 channel 平台逻辑放 pkuclaw/channels/
  • 通知脚本保持 thin client,不直连平台 API。
  • loop 默认静默,只有重要变化才通知。

Review 重点

  • 是否引入了第三类 run source?如果是,通常应退回设计。
  • 是否把 channel/platform 细节泄露到 core 或 Agent prompt?
  • 是否让 Agent 直接接触敏感凭据或目标 ID?
  • 是否破坏了 realtime 和 loop 的 prompt 边界?
  • 是否同步更新了文档和测试?

On this page