Kubernetes 网站项目：如何发起拉取请求（PR）

Kubernetes 网站项目：如何发起拉取请求（PR）

website Kubernetes website and documentation repo: 项目地址: https://gitcode.com/gh_mirrors/webs/website

概述

在 Kubernetes 网站项目中，贡献新内容或改进现有内容都需要通过发起拉取请求（Pull Request，简称 PR）来完成。本文将详细介绍两种发起 PR 的方式：适合小变更的 GitHub 在线编辑方式和适合大变更的本地开发方式。

方法一：GitHub 在线编辑（适合小变更）

操作步骤

1. 定位目标页面：找到需要修改的文档页面
2. 进入编辑模式：点击页面右侧导航栏的"编辑此页"按钮
3. 修改内容：使用 GitHub 的 Markdown 编辑器进行修改
4. 提交变更：
   • 填写提交信息标题（简明扼要）
   • 添加详细描述（可选）
   • 注意：不要使用 GitHub 自动关联的关键词
5. 创建 PR：
   • 检查变更内容
   • 填写 PR 描述（详细说明修改原因和内容）
   • 保持"允许维护者编辑"选项勾选

注意事项

• 对于简单的拼写错误或格式修正，这种方法最为便捷
• PR 描述是帮助评审者理解变更的重要途径，请认真填写
• 变更会经过社区成员评审后才被合并

方法二：本地开发（适合大变更）

前期准备

1. 安装必要工具：

   • Git 版本控制系统
   • 可选：Git 图形界面工具

2. 派生仓库：

   • 创建个人派生仓库

本地开发流程

1. 克隆仓库：

   git clone git@github.com:<你的用户名>/website
   cd website
   

2. 设置上游仓库：

   git remote add upstream https://github.com/kubernetes/website.git
   

3. 创建开发分支：

   git checkout -b <分支名> upstream/main
   

4. 进行修改：

   • 使用文本编辑器修改文档
   • 使用 git status 随时查看变更状态

提交变更

1. 添加文件到暂存区：

   git add <文件名>
   

2. 创建提交：

   git commit -m "描述性提交信息"
   

3. 推送到远程：

   git push origin <分支名>
   

本地预览

在提交 PR 前，建议在本地预览修改效果：

容器方式（推荐）

1. 初始化子模块：

   make module-init
   

2. 启动本地服务：

   make container-serve
   

3. 访问 http://localhost:1313 查看效果

本地 Hugo 方式

1. 安装 Hugo 和 Node.js（特定版本）

2. 安装依赖：

   npm ci
   

3. 启动服务：

   make server
   

创建 PR

1. 从你的派生仓库向主仓库发起 PR

2. 填写详细的 PR 描述：

   • 说明变更原因
   • 描述具体修改内容
   • 关联相关 issue（如有）

3. 等待社区评审：

   • 可能需要根据反馈进行修改
   • 可通过 Slack 频道跟进进度

最佳实践

1. 分支策略：

   • 现有内容改进：基于 upstream/main
   • 新功能文档：使用特性分支
   • 本地化内容：遵循本地化规范

2. 提交信息：

   • 标题简明扼要
   • 正文详细说明（如需）

3. 变更大小：

   • 大变更建议拆分为多个小 PR
   • 每个 PR 专注解决一个问题

通过遵循这些步骤和最佳实践，你可以高效地为 Kubernetes 网站项目贡献内容，并与社区成员顺畅协作。

website Kubernetes website and documentation repo: 项目地址: https://gitcode.com/gh_mirrors/webs/website