Skip to content

README.zh-CN.md

Latest commit

 

History

History
61 lines (43 loc) · 3.31 KB

README.zh-CN.md

File metadata and controls

61 lines (43 loc) · 3.31 KB
Raw

Qoder Cloud Agents Cookbook

English · 投稿说明 · 内容契约 · Qoder Cloud Agents

Qoder Cloud Agents Cookbook 是面向 Cloud Agents 用户的公开实践内容源。Cookbook 页面只提供阅读能力；每一篇公开内容都来自本仓库中经过自动检查和人工审核的 Pull Request。文章还可以附带强绑定的 Demo 源码，但源码只保留在 GitHub，不进入 Cookbook 发布物。

内容类型

类型 适合的内容
Recipe 完成一个明确任务的可复用方法
Best Practice 生产建议、适用边界与关键权衡
Showcase 完整场景、实现思路与成果
Workshop 培训、分享或团队学习材料

仓库支持 zh-CN 和 en-US，内容路径为 content/<locale>/<type>/<slug>/index.md。可选源码路径为 demos/<slug>/，Demo slug 必须与其所属文章一致。终稿 PRD 中首发内容为待补充，因此初始仓库不会放入虚构的可发布文章或可运行 Demo，后续内容通过 PR 持续增加。

content/<locale>/<type>/<slug>/index.md   发布为 Cookbook 页面
demos/<slug>/                             可选、仅保留在 GitHub 的 Demo 源码

投稿

  1. 阅读 中文投稿说明。
  2. 从 templates/ 复制对应模板。
  3. 在 content/ 的正确目录中创建文章和本地资源。
  4. 可选：增加强绑定的 demos/<slug>/，并在文章正文中链接它。
  5. 如果本地有 Node.js 20 或更高版本，可选择运行推荐的本地检查。
  6. 使用 git commit -s 提交并创建 Pull Request。

提交投稿不强制要求本地检查。作者创建或更新 PR 后，GitHub Actions 会自动检查格式与渲染契约，并生成必需的文章预览。Demo 源码只作为不可信数据接受静态检查，自动化不会安装、构建、测试或运行它。自动检查通过不代表内容自动发布；Maintainer 仍会人工审核事实、源码、运行说明、公开范围、风险、授权和内容价值，并人工 Merge。

可选的本地检查

如果本地有 Node.js 20 或更高版本，建议运行以下命令以便更快发现问题：

npm ci --ignore-scripts
npm run check

页面预览写入 dist/preview/，不提交到仓库。没有 Node.js 的投稿者可以直接创建 PR，并查看 GitHub Actions 生成的预览。

内容契约

许可证

正文、内容图片、模板和文档使用 CC BY 4.0；Demo 源码、可执行工具、工作流、测试和独立示例代码使用 Apache-2.0。详细适用范围见 LICENSE 和 NOTICE。

投稿内容适用相同许可证，并要求所有 commit 满足 DCO 签署。