贡献流程

相关源文件

• CONTRIBUTING.md
• LICENSE.txt
• PULL_REQUEST_TEMPLATE.md

概述

本文档详细介绍了向 You-Dont-Know-JS 存储库贡献的正式流程。它涵盖了拉取请求提交指南、许可条款和范围限制。有关问题模板的具体指导，请参阅 问题模板。有关贡献翻译的内容，请参阅 翻译指南。

来源：CONTRIBUTING.md1-35

贡献资格

该存储库根据书籍版本和完成状态维护特定的贡献资格标准。

书籍	标题	状态	开放贡献
1	入门	已发布（2020 年）	否
2	作用域与闭包	已发布（2020 年）	否
3	对象与类	稳定草稿（约 90-95%）	是
4	类型与语法	稳定草稿（约 90-95%）	是
5	同步与异步	暂未计划	不适用
6	ES.Next 及未来	暂未计划	不适用

注意：任何情况下都不接受对第一版书籍的贡献。

来源：CONTRIBUTING.md19-25

贡献流程图

来源：CONTRIBUTING.md3-4 CONTRIBUTING.md34-35 PULL_REQUEST_TEMPLATE.md13-23

许可条款

向存储库的所有内容贡献都必须遵守贡献者必须同意的特定许可条款。

贡献许可协议

通过向存储库贡献内容（非错别字修正），贡献者自动授予作者和出版商一项非排他性许可，允许他们根据认为适合书籍的方式使用所贡献的内容。

来源：CONTRIBUTING.md5

存储库许可

整个存储库内容根据知识共享署名-非商业性使用-禁止演绎 4.0 国际许可协议（CC BY-NC-ND 4.0）许可，该协议规定：

• 署名：内容必须署原作者名
• 非商业性使用：材料不得用于商业目的
• 禁止演绎：禁止公开分享改编作品

来源：LICENSE.txt1-2 LICENSE.txt56-68 LICENSE.txt143-152

拉取请求指南

先决条件

在提交拉取请求之前，贡献者应

1. 仔细阅读贡献指南文档
2. 搜索与他们的贡献相关的现有问题
3. 检查他们想修改的书籍/章节是否对贡献开放

PR 模板字段

所有拉取请求都必须使用提供的模板并包含

字段	描述
确认	确认已阅读贡献指南
搜索确认	“我已搜索过此问题”
版本	（不接受对先前版本的拉取请求）
书籍标题	贡献适用的书籍
章节	章节编号/名称
章节标题	修改的具体章节
主题	贡献主题的简要描述

来源：PULL_REQUEST_TEMPLATE.md1-23

特定贡献政策

错别字修正

• 细微的文本错别字将在编辑过程中被发现
• 如果提交错别字修复，请将几处小改动收集到一个 PR 中，使用单独的提交
• 考虑推迟细微错别字修复，因为它们将在最终编辑时处理

交叉引用和阅读体验

存储库不接受旨在通过以下方式改进阅读体验的贡献

• 章节之间的交叉链接
• 导航增强
• 其他阅读体验改进

该存储库优先处理出版目的的内容跟踪和管理，将免费访问作为次要优势。

来源：CONTRIBUTING.md7-17 CONTRIBUTING.md27-31

贡献者最佳实践

1. 先征求意见：如果有任何关于贡献的疑问，请在提交 PR 之前先创建一个 issue 进行讨论
2. 彻底搜索：在创建新 issue 之前，请同时检查开放和已关闭的 issue
3. 遵循模板：完整填写 PR 模板
4. 尊重书籍状态：只贡献到标记为“开放贡献”的书籍
5. 了解许可：请注意，贡献内容将被许可以可能包含在已出版的作品中

来源：CONTRIBUTING.md3-5 PULL_REQUEST_TEMPLATE.md1-10

贡献决策流程

来源：CONTRIBUTING.md19-25 CONTRIBUTING.md7-17 CONTRIBUTING.md3-4