贡献指南

相关源文件

• .github/workflows/welcome.yml
• CONTRIBUTING.md
• README.md

本文档概述了为 System Design 101 存储库做出贡献的流程和要求。这些指南可确保所有贡献的统一性和质量，使该存储库成为学习系统设计概念的宝贵资源。

目的与范围

System Design 101 存储库是一个全面的教育资源，它使用视觉效果和简单的术语来解释复杂的系统。这些贡献指南通过为提交拉取请求、报告问题和参与项目建立明确的标准，有助于保持存储库的质量。

来源：CONTRIBUTING.md1-4 README.md17-21

贡献工作流程

下图说明了为 System Design 101 存储库做出贡献的标准工作流程

对于首次贡献者，一个自动化的欢迎工作流程会发送问候消息并提醒他们贡献指南。

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

拉取请求指南

存储库维护者为拉取请求制定了具体要求，以确保质量和一致性

主要要求

要求	描述
单一主题聚焦	每个 PR 应只关注一个主题或概念
清晰的 PR 标题	标题应简洁地总结所处理的主题
禁止直接编辑图表	报告图表问题，而不是直接修复图像
禁止 AI 生成内容	内容应由人类贡献者创建，而非 AI 工具
文档标准	内容应使用视觉效果和简单的术语来解释复杂的系统

拉取请求工作流程

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

报告图表问题

贡献者应遵循此流程，而不是直接编辑图表图像

此方法可确保源图像得到妥善维护，并附带更正后重新发布。

来源：CONTRIBUTING.md11-12

自动化欢迎流程

对于首次贡献者，存储库已实施了一个自动化的欢迎工作流程，该工作流程会在有人打开他们的第一个问题或拉取请求时触发。

欢迎消息

1. 感谢贡献者首次做出贡献
2. 提醒他们遵循贡献指南
3. 告知他们不遵守指南的 PR 将被关闭
4. 表达对他们贡献的赞赏

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

翻译政策

目前，System Design 101 存储库不接受其他语言的翻译。有兴趣的贡献者可以关注或订阅存储库，以便在翻译机会可用时收到通知。

来源：CONTRIBUTING.md18-20

GitHub 拉取请求文档

如果您不熟悉拉取请求流程，GitHub 提供了全面的文档来帮助您入门。存储库维护者建议在提交您的贡献之前，先查看 拉取请求文档。

来源：CONTRIBUTING.md14-16

存储库许可证

需要注意的是，对 System Design 101 存储库的贡献需遵守该存储库的许可证。内容已获得知识共享署名-非商业性使用-禁止演绎 4.0 国际 (CC BY-NC-ND 4.0) 许可。

来源：README.md450-452

相关资源

有关 System Design 101 存储库结构的更多信息，请参阅 存储库结构。