Deno 中文文档贡献指南
我们欢迎和感谢所有对Deno作出的贡献。
这个页面旨在帮助你开始贡献。
项目
Deno生态系统中有很多处于 denoland 组织下的仓库。
这些仓库具有不同的范围、使用不同的编程语言，对于贡献的难度程度也有所不同。
为了帮助你决定哪个仓库可能是最适合开始贡献（或许是你感兴趣的），以下是一个简要的比较（粗体编程语言占据了大多数的代码库）：
deno
这是提供 deno CLI 的主要仓库。
如果你想要修补deno的bug或是增加新的特性，则你需要贡献到这个仓库。
编程语言：Rust, JavaScript
deno_std
提供给Deno使用的标准库。
编程语言：TypeScript, WebAssembly.
dotland
官方Deno网页的前端: https://deno.land/
编程语言：TypeScript, TSX, CSS
deno_lint
支持deno lint命令的代码检查工具。
编程语言：Rust
deno_doc
支持deno doc命令的文档生成器以及 https://doc.deno.land
编程语言：Rust
docland
文档生成器的前端: https://doc.deno.land
编程语言：TypeScript, TSX, CSS
rusty_v8
V8 JavaScript引擎的Rust绑定。非常技术性和底层。
编程语言：Rust
serde_v8
在V8和Rust对象之间提供双射层的库。 基于
serde 库。非常技术性和底层。
编程语言：Rust
deno_docker
Deno官方的Docker images。
一般注意事项
阅读 样式指南 。
请不要使 基准测试 变差。
在 社区聊天室 中寻求帮助。
如果你要处理一个问题，请先在问题评论中提及，然后再开始处理问题。
如果你将要处理一个新特性，请先创建一个问题并与其他贡献者讨论，然后再开始处理；我们感谢所有的贡献，但并不是所有提出的特性都会被接受。 我们不希望你花费数小时来处理可能不被接受的代码。
在论坛上请保持专业。 我们遵守 Rust的行为准则 (CoC)。遇到问题？给 ry@tinyclouds.org 发邮件。
提交拉取请求
在向任何仓库提交PR之前，请确保完成以下操作：
- 给PR一个描述性标题。
好的PR标题示例:
- fix(std/http): Fix race condition in server
- docs(console): Update docstrings
- feat(doc): Handle nested re-exports
差的PR标题示例：
- fix #7123
- update docs
- fix bugs
- 确保存在相关的问题，并在PR文本中进行引用。
- 确保有涵盖更改的测试。
向 deno 提交PR
除了以上所述，还请确保：
cargo test通过 - 这将运行完整的测试套件，包括单元测试、集成测试和Web Platform Tests.运行
./tools/format.js- 这将格式化所有代码，以符合存储库中的一致样式。运行
./tools/lint.js- 这将使用clippy（针对Rust）和dlint（针对JavaScript）对Rust和JavaScript代码进行常见错误和错误的检查。
向 deno_std 提交PR
除了以上所述，还请确保：
你编写的所有代码都使用
TypeScript（即不要使用JavaScript）。deno test --unstable --allow-all通过 - 这将运行标准库的全部测试套件。在仓库的根目录下运行
deno fmt- 这会将所有代码格式化以符合存储库中的一致样式。运行
deno lint- 这将检查TypeScript代码的常见错误和错误。
向 denoland/manual 提交PR
如果你想要向这篇手册提交PR，请确保所有标准库的导入都用“$ STD_VERSION”替换了数字版本。
这是最新版本 here .
API文档
重点是要记录所有公共API，我们想要让它们与代码内联一起进行记录。这有助于确保代码和文档是紧密耦合的。
JavaScript和TypeScript
所有公开暴露的API和类型，无论是通过 deno 模块还是全局/window
命名空间，都应该有 JSDoc 文档。 此文档会被解析并提供给 TypeScript
编译器，因此易于向下提供。
JSDoc块位于它们应用的语句之前，并以一个前导/**开始，然后以 */结束。例如：
/** A simple JSDoc comment */
export const FOO = "foo";
更多信息，请访问： https://jsdoc.app/
Rust
使用 this guide 来编写Rust代码的文档注释。