文档/项目

项目

贡献与许可

参与 SAG 开发、提交变更并遵循 MIT 许可。
更新于 2026-07-22适用于 SAG v1.2.2

SAG 是 MIT 许可的开源项目。欢迎提交缺陷修复、文档、测试、连接器与经过讨论的产品改进。

开始之前

  1. 阅读仓库 CONTRIBUTING.md
  2. 搜索现有 Issue 与 Pull Request,避免重复工作。
  3. 对架构或行为变化较大的提案先创建 Issue,说明问题、用户影响与兼容性。
  4. 从最新 main 创建聚焦分支。

代码边界

贡献应保持核心依赖规则:应用代码只通过 apps/api/sag_api/sag/ 访问 zleap-sag。不要让知识引擎反向依赖 FastAPI、Web UI、用户、会话或引用模型。

前端新增文案应同步 en-USzh-CN 消息;API 变化应更新 Schema、OpenAPI 行为和相关文档。

提交前检查

bash
cd apps/api
ruff check .

cd apps/web
npm run i18n:check
npm run typecheck
npm run build

根据改动范围运行更具体的测试。修复缺陷时应提供能覆盖原问题的回归验证。

安全信息

不要把真实 JWT、模型 Key、Apple 签名凭据、数据库密码或私人文档提交到代码、Issue、截图和日志。

公开问题中只提供已经脱敏的最小日志。涉及尚未公开的安全漏洞时,不应先创建包含利用细节的公开 Issue。

许可

SAG 使用 MIT License。提交贡献即表示相关代码可以按项目许可分发。

相关项目:

发现内容问题?以当前公开仓库为准。查看 SAG 源码