为 Scala 项目贡献文档
你可以通过多种方式帮助改进 Scala 文档。其中包括
- Scaladoc 中的 API 文档
- docs.scala-lang.org 网站上的指南、概述、教程、备忘单等
- 更新 scala-lang.org
在贡献文档之前，请仔细阅读此页面以及从此页面链接的页面。这些资源中将回答许多常见问题。如果你有未得到解答的问题，请随时在 Scala 贡献者 论坛上提问，然后提交一个包含反映该答案的更新文档的拉取请求。
文档提交的一般要求包括拼写检查所有书面语言、确保代码示例编译并正确运行、正确的语法以及文档的干净格式/布局。
感谢
API 文档（Scaladoc）
Scala API 文档与 scala 项目源代码一起存在。你可以通过多种方式帮助改进 Scaladoc，包括
- 记录缺少 scaladoc 文档的问题 - 请严格按照问题提交流程进行操作，以帮助防止创建重复的问题。
- 认领 Scaladoc 问题并提供文档 - 请在处理特定 scaladoc 任务之前认领问题，以防止重复工作。如果你在不提交请求的情况下处理一个问题太久，它将恢复为未分配状态，你需要重新认领它。
- 你还可以直接提交新的 Scaladoc，而无需创建问题，但请查看你的任务是否已经有人提交了问题，如果有，请认领它。如果没有，请在Scala 贡献者上发布你处理特定 scaladoc 任务的意向，以便人们知道你在做什么。
Scala 主要文档网站
docs.scala-lang.org 存放着 Scala 的主要书面非 API 文档来源。这是一个 GitHub 项目，你可以对其进行 fork 并提交请求。它包括
- 概述
- 教程
- 其他语言的转换指南
- 备忘单
- 词汇表
- Scala 风格指南
- Scala 语言规范
- SIP（Scala 改进流程）提案等
在进行更改之前，请阅读添加新的指南/教程。该网站使用Jekyll Markdown 引擎，因此你需要按照说明进行操作。
更新 scala-lang.org
其他高级文档（包括有关对 Scala 和相关项目进行贡献的文档）在Scala 语言网站上提供，并且还保存在scala-lang GitHub 项目中，可以对其进行 fork 以创建请求。
在对 Scala 语言网站进行任何更改之前，请阅读添加新的指南/教程文档和scala-lang.org GitHub 自述文件，因为它使用与 Scala 文档网站相同的 Jekyll markdown 工具和许多相同的约定。