贡献工作流程

相关源文件

• .operations/CONTRIBUTING.md
• .operations/common-answers.md
• .operations/operations-manual.md
• .operations/writing-guidelines.chinese.md
• .operations/writing-guidelines.french.md
• .operations/writing-guidelines.japanese.md
• .operations/writing-guidelines.md
• .operations/writing-guidelines.polish.md
• .operations/writing-guidelines.russian.md

本文档描述了为 Node.js 最佳实践存储库贡献的端到端流程。它涵盖了贡献的提交、审查和最终合并到主代码库的过程。有关翻译贡献的具体信息，请参阅 翻译流程。有关如何认可贡献者，请参阅 贡献者认可。

概述

Node.js 最佳实践存储库欢迎社区的贡献，以帮助改进和扩展其 Node.js 最佳实践的集合。本文档概述了贡献的工作流程和指南，以确保流程顺畅高效。

来源：.operations/CONTRIBUTING.md1-9 .operations/operations-manual.md1-9

贡献类型

该存储库接受几种类型的贡献，每种类型都有其自己的处理流程

贡献类型	描述	进程
新的最佳实践	添加新的建议或根本性地更改现有内容	需要至少一位其他协作者的反馈，评论期为一周
文本更正	语法、拼写错误或细微的语言改进	可以立即批准并合并
新的翻译	将内容翻译成以前不支持的语言	需要遵循特定的翻译指南
翻译编辑	对现有翻译的更新	简单的更改可以直接合并；复杂的更改需要原始翻译者的反馈
讨论/想法	一般性对话或建议	根据主题的复杂性和范围进行处理

来源：.operations/CONTRIBUTING.md10-30

贡献流程

贡献工作流程图

来源：.operations/CONTRIBUTING.md10-28 .operations/operations-manual.md4-9

处理流程详情

初步分类

当提交新的贡献（作为 issue 或 pull request）时，核心团队成员将：

1. 为贡献打上适当的标签
2. 将其路由给擅长相关主题的人员
3. 确保贡献者受到热烈欢迎（最好在 48 小时内）

目标是从每个贡献中学习，并可能将贡献者融入项目社区。

来源：.operations/operations-manual.md4-9

专业路由

贡献将根据团队成员的专业领域进行路由

主题路由系统

来源：.operations/operations-manual.md54-69

具体的贡献流程

新的最佳实践或根本性更改

对于重要的内容添加或更改

1. 热情问候贡献者
2. 确保手续齐全（格式正确等）
3. 验证是否符合 写作指南
4. 获取至少一位其他协作者的反馈
5. 允许至少一周的评论期
6. 如果获得批准，则合并

来源：.operations/CONTRIBUTING.md20

文本更改（语法、拼写错误）

对于简单的文本更正

1. 问候贡献者
2. 验证更改是否恰当
3. 立即批准并合并

来源：.operations/CONTRIBUTING.md22

新的翻译

对于新的语言翻译

1. 问候贡献者
2. 提供翻译指南，包括：
   • 在自己的 fork 上工作
   • 专注于翻译，不进行内容编辑
   • 复制文件并使用适当的语言命名
   • 与其他翻译人员合作

来源：.operations/CONTRIBUTING.md24 .operations/common-answers.md1-17

翻译编辑

对于现有翻译的更改

1. 如果更改可以推断（符号、数字、日期更新），则直接合并
2. 如果需要语言熟悉度，请标记原始翻译者以获取反馈

来源：.operations/CONTRIBUTING.md26

贡献者鸣谢

合并贡献后，请使用 all-contributors bot 将贡献者添加到荣誉名单中

@all-contributors please add @username for content

这确保了贡献者因其贡献而获得应有的认可。

来源：.operations/CONTRIBUTING.md14-16

贡献模型和角色

该项目有一个结构化的贡献模型，包含不同的角色

指导委员会

成员们：

• 提供指导和未来方向
• 分享特定领域的专业知识
• 批准新的最佳实践
• 确保现有实践保持相关性

贡献者

定期贡献者：

• 建议新的最佳实践
• 对 issues 进行分类
• 审查 pull requests
• 帮助维护高质量、最新的内容
• 领导特定项目

协作者状态是根据贡献的质量和一致性授予的。不活跃的协作者可能会退出或继续保留其角色。

来源：.operations/CONTRIBUTING.md49-62

预提交要求

在推送贡献之前，请验证 Markdown 是否通过了 linter 检查

用于修复基本错误

这可确保一致的格式和质量标准。

来源：.operations/CONTRIBUTING.md36-47

月度维护

每个月，指定维护者会执行常规的维护任务

1. 更新顶部徽章，包括最佳实践计数、最后更新日期和 Node.js 版本
2. 确保所有翻译都与英文版本保持一致
3. 更新贡献者认可（“感谢”星星和鲜花）
4. 通知并感谢本月贡献者

这确保了存储库保持最新状态，并且贡献者得到认可。

来源：.operations/operations-manual.md14-39

写作指南

所有内容必须符合项目的写作指南，该指南强调：

1. 简洁性优于复杂性
2. 基于证据且可靠的内容
3. 全面覆盖（MECE - 互斥、穷尽）
4. 一致的格式化
5. 专注于 Node.js
6. 仅推荐领先的供应商

有关完整详情，请参阅 写作指南

来源：.operations/writing-guidelines.md1-32

内容质量流程

内容质量保证流程

来源：.operations/CONTRIBUTING.md20-26 .operations/writing-guidelines.md1-32