拉取请求流程

PR 提交指南

System Design 101 仓库维护着特定的 Pull Request 提交指南，以确保所有教育材料的质量和一致性。贡献者在 PR 审阅时必须遵守这些指南。

核心指南

指南	描述
单一主题聚焦	每个 PR 应专注于单一主题或概念。
清晰的标题	PR 标题必须清晰地概述所处理的主题。
无跨主题更改	避免在同一个 PR 中进行跨多个主题的更改。
图表问题	对于图表错误，请提交 issue，而不是直接修改图片。
无 AI 生成内容	内容不得使用 AI 工具生成。
无翻译	目前不接受其他语言的翻译。

来源：CONTRIBUTING.md6-13

PR 工作流程图

来源：CONTRIBUTING.md6-13 .github/workflows/welcome.yml1-23

PR 步骤流程

1. Fork 仓库

首先，将 System Design 101 仓库 Fork 到您自己的 GitHub 账户。

2. 创建分支

在您 Fork 的仓库中为您的更改创建一个新分支。

git checkout -b your-feature-branch

3. 进行更改

进行所需的更改，请遵循以下关键规则：

专注于单一主题或概念
请勿直接修改图表图片。
确保内容不是 AI 生成的。
请勿包含其他语言的翻译。

4. 创建拉取请求

在您的更改准备就绪后：

将您的分支推送到您 Fork 的仓库。
导航到原始的 System Design 101 仓库。
点击“New Pull Request”（新建 Pull Request）。
选择“compare across forks”（跨 Fork 比较）。
选择您的 Fork 和分支。
提供一个清晰、描述性的标题，概述您的更改。
在 PR 描述中填写有关您贡献的详细信息。
提交 Pull Request。

来源：CONTRIBUTING.md6-13

5. 自动化欢迎工作流程

对于首次贡献者，系统会触发一个自动化的欢迎消息，提醒您遵循贡献指南。这是通过 .github/workflows/welcome.yml 中定义的 GitHub Actions 工作流程实现的。

来源：.github/workflows/welcome.yml1-23

PR 验证标准

仓库维护者在合并所有 Pull Request 之前，会根据既定指南进行验证。此验证侧重于技术内容和对贡献标准的遵守情况。

验证标准表

标准	描述	未达标时的结果
单一主题	PR 只处理一个主题或概念。	PR 可能会被关闭或要求拆分。
清晰的标题	标题清晰地概述了更改。	要求修改。
无跨主题更改	更改不跨越多个主题。	PR 可能会被关闭或要求拆分。
未直接编辑图表	图表问题被报告，而不是在 PR 中直接修复。	PR 已关闭，改为提交 issue。
原创内容	内容不是 AI 生成的。	PR 已关闭。
无翻译	无其他语言的翻译。	PR 已关闭。
质量	内容符合仓库质量标准。	要求修改。

来源：CONTRIBUTING.md6-13 .github/workflows/welcome.yml18-22

常见的 PR 问题及解决方案

以下是 Pull Request 中经常遇到的问题及其推荐的解决方案：

问题	解决方案
PR 包含多个主题	拆分成单独的 PR，每个 PR 专注于一个主题。
图表错误被直接修复	请提交 issue，让维护者修复源图。
PR 标题不清晰	修改标题，以清晰地说明具体更改。
AI 生成内容	使用原始内容，不要使用 AI 生成工具。
翻译贡献	暂时搁置，直到翻译被正式支持。

来源：CONTRIBUTING.md6-20

其他资源

对于不熟悉 GitHub Pull Request 系统的贡献者，仓库建议参考官方 GitHub Pull Request 文档，如 CONTRIBUTING.md14-16 中提到的。

总结

System Design 101 的 Pull Request 流程旨在维护教育资源的质量和一致性。通过遵循本文档概述的特定指南，贡献者可以帮助确保他们的提交被成功审查和合并。

要记住的关键点

贡献应专注于单一主题。
PR 标题必须清晰且具有描述性。
图表问题应被报告，而非直接修复。
内容必须是原创的，不是 AI 生成的。
目前不接受翻译。

遵循这些指南将有助于确保您的贡献能够被高效地审查并纳入 System Design 101 仓库。

来源：CONTRIBUTING.md1-20 .github/workflows/welcome.yml1-23