跳转到内容
搜索文档
↵选择
↑↓导航
ESC关闭

贡献

最后更新 查看 MarkdownAgent 设置

Cloudflare Docs 是开源的，托管在 GitHub 上的 cloudflare-docs 仓库 ↗。这意味着任何人，包括非 Cloudflare 组织的成员，都可以对文档做出贡献。我们欢迎所有有助于保持我们文档高质量和最新状态的建议。

要对我们的文档做出贡献，您需要在 GitHub 上创建一个账户 ↗（如果您还没有的话）并登录。然后您有以下三个选择：

  • GitHub issue：快速提交常规建议。
  • 快速编辑 (编辑按钮)：快速创建 pull request。如果您想在 Web 浏览器中编辑单个页面且不需要预览更改，这是最佳选择。
  • 完整开发：创建 pull request。如果您想编辑多个页面并预览更改，这是最佳选择。这可以在您的 Web 浏览器中（使用 Codespaces ↗）或在您的本地计算机上（使用 Visual Studio Code ↗）进行。

除了使用 Cloudflare 风格指南 获取语法和风格指导外，我们还建议浏览我们的组件，以添加按钮、标签页和可折叠部分等其他格式。

创建 GitHub issue

要创建 GitHub issue：

  1. 登录 GitHub ↗ 并前往 cloudflare-docs 仓库 ↗。
  2. 选择 Issues，然后选择 New issue。
  3. 选择 issue 类型，填写表单，然后选择 Create。

了解有关创建 GitHub issue 的更多信息。 ↗

快速编辑

要使用编辑按钮快速创建 pull request：

  1. 登录 GitHub ↗。

  2. 前往 Cloudflare Docs 中您要编辑的页面

  3. 选择

    Edit 或 Edit page

    Cloudflare Docs 中的每个页面（包括此页面）在右侧边栏都有一个 Edit 按钮，在页面最底部有一个 Edit page 按钮。 编辑图标
    页面的 Markdown 将会打开。

  4. 进行编辑并选择 Commit changes。

  5. 在表单中，更新 Commit message，在方括号中注明您更改的产品，并简要描述您的更改。例如 “[Images] Fixed broken link.”

  6. 更新 Extended description，提供有关您更改了什么以及原因的更多详细信息。细节越详细越好。

  7. 依次选择 Propose changes > Create pull request > 再次选择 Create pull request。

完整开发

要通过完整开发工作流 ↗进行编辑并创建 pull request：

  1. 登录 GitHub ↗ 并 fork cloudflare-docs 仓库 ↗。
  2. 如果您在 Web 浏览器中编辑（使用 Codespaces ↗），请转到步骤 3。
    如果您在本地计算机上编辑（使用 Visual Studio Code ↗）：
  3. 从您的 fork（或克隆）创建一个分支。
  4. 进行编辑。
  1. 提交您的更改。
  2. 将您的 commit 推送到您的分支，然后推送到您的 fork。
  3. 返回 GitHub 并根据您提交的更改创建 pull request。在描述表单中，在方括号中加入您更改的产品，并简要描述您的更改。例如 “[Images] Fixed broken link.”

创建 issue 或 PR 后

在您创建 issue 或 PR 后，Cloudflare 组织的成员将审核您的建议。以下是后续流程：

  • Cloudflare 组织的成员可能会标记其他人进行技术或内容审核，或者提供反馈。
  • 如果您的建议需要更多信息，Cloudflare 组织的成员可能会通过评论提出后续或澄清问题。如果他们添加了 more-information-needed 标签，且您在 14 下内未做出回应，该 issue 或 pull request 将自动关闭。
  • 如果您的更改被批准：
    • 对于 GitHub issue，Cloudflare 成员可能会创建并链接一个解决您请求的新 pull request。当他们合并 PR 时，也将关闭您的 issue。
    • 对于 GitHub PR，Cloudflare 成员将合并您的 PR。
  • 如果您的建议未被批准，Cloudflare 成员将说明原因并关闭您的 issue 或 PR。

感谢您为我们的开源生态系统做出贡献，并成为 Cloudflare 社区的一员。

使用 AI 为 Cloudflare 文档做出贡献

cloudflare-docs 仓库包含一个 AGENTS.md ↗ 文件，它能帮助 AI 编码代理（coding agent）理解仓库的结构、工具和约定，以便他们在为文档做出贡献时进行正确且可构建的更改。

AGENTS.md ↗ 是一种用于引导编码代理的简单、开放的格式。

该仓库开箱即用地包含了以下 AI 工具的配置：

Agent 的技能、命令和 agent 定义都保存在 .agents/ 中，并会自动符号链接到每个工具的预期位置。

这篇文档对您有帮助吗？