本页面介绍了向 You Don't Know JS Yet (YDKJSY) 存储库贡献的指南和流程。它涵盖了可接受的贡献类型、提交更改的工作流程、问题报告和翻译指南。
YDKJSY 项目既是一个开源存储库,也是一个已出版的系列书籍。这种双重性质影响了接受的贡献类型及其管理方式。
YDKJSY 项目目前处于第二版。每本书的贡献状态如下
| 书籍 | 标题 | 状态 | 开放贡献 |
|---|---|---|---|
| 1 | 入门 | 已完成/已出版 | 否 |
| 2 | 作用域与闭包 | 已完成/已出版 | 否 |
| 3 | 对象与类 | 稳定草稿(约 90-95%) | 是 |
| 4 | 类型与语法 | 稳定草稿(约 90-95%) | 是 |
| 5 | 同步与异步 | 暂无计划 | 否 |
| 6 | ES.Next 及未来 | 暂无计划 | 否 |
第一版书籍不接受任何贡献,无一例外。
图表:YDKJSY 贡献流程
提交任何贡献之前
来源:CONTRIBUTING.md3-5 CONTRIBUTING.md33-35 PULL_REQUEST_TEMPLATE.md1-4
来源:CONTRIBUTING.md7-17 CONTRIBUTING.md27-31
图表:问题类型和模板
该存储库为不同类型的问题提供了专用模板
每个模板都需要特定信息,例如
来源:.github/ISSUE_TEMPLATE/report-technical-mistake.md1-22 .github/ISSUE_TEMPLATE/content-question.md1-22 .github/ISSUE_TEMPLATE/textual-grammar-typo.md1-22
欢迎对 YDKJSY 系列进行外语翻译,但应遵循以下步骤
图表:翻译流程
翻译流程包括
翻译请求应等到第二版完成。不接受先前版本的新外语翻译。
来源:.github/ISSUE_TEMPLATE/foreign-translation-request.md8-27
YDKJSY 存储库采用知识共享署名-非商业性使用-禁止演绎 4.0 国际公共许可证授权。通过向此存储库贡献,您同意您的贡献也将受此相同许可证的约束。
主要许可条款
当您贡献内容时,您授予作者非独占许可,可以由作者和出版商酌情将该内容用于书籍。
来源:LICENSE.txt1-2 CONTRIBUTING.md5
提交拉取请求时
对于错别字修正,请将多个小更改合并到一个 PR 中,并使用单独的提交,而不是提交多个 PR。