贡献

要文明。如果你需要一个行为准则,可以看看 Bevy 的。

如果你对这本书有任何建议,例如关于新内容的想法,或者你注意到任何不正确或误导性的东西,请在[GitHub仓库][project::cb]中提出问题!

贡献代码

如果你只是想为本书贡献代码实例,请随时发起一个 PR。我可以负责编辑书中的文字和页面,你的代码将被显示在上面。

手册实例

手册实例的代码应该作为一个完整的、可运行的实例文件提供,放在 src/code/examples 下。书的页面将只显示代码的相关部分,而非不必要的模板代码。

始终使用 [mdbook anchor syntax][mdbook::anchor-syntax],而不是行号,来表示页面上要显示的代码部分。

Credits

如果你提供了一个手册实例,我将在书中以你的 github 用户名注明你的名字,并附上 PR 的链接。如果你不希望被引用,或者你希望以其他方式被引用,请告诉我(但内容不允许进行商业性的自我宣传)。

贡献书籍文本

我不直接合并其他人写的书本内容。这是因为我希望这本书能遵循一个统一的编写风格。

如果你想为这本书写新的内容,请随时提出要包括的内容的 PR,但请注意,它很可能不会完全按照你写的内容来保存。

我可能会把它合并到一个临时的分支中,然后按照我认为合适的方式进行编辑或改写,以便发表到书中。

许可证

为了避免版权和许可方面的复杂情况,你同意在 MIT-0 No Attribution License 许可下提供你对项目的任何贡献。

请注意,这允许你的作品在不保留你的版权的情况下被重新授权。

如前所述,书中实际出版的内容将是我在你的贡献基础上的衍生作品。我将把它与书中的其他内容统一授权,见:许可证

Bevy 版本

为当前 Bevy 版本所写的内容,被接受为本书的 main 分支。

为 Bevy 主分支的新开发而写的内容,可接受为本书的 next 分支,为下一个即将发布的 Bevy 版本做准备。

风格指南

力求简单和简约。不要包括与表达与内容无关的东西。

"完美非指无所增加、而是无所减少的时候。"

不要忘记指出潜在的问题和其他相关的实际思法。

尽量使用最常见/标准的术语和关键词,以使事情容易找到。不要想出你自己的新的/额外的术语。

避免重复在书中其他地方能找到的内容,最好使用关联链接。

代码风格

避免单行过长的代码,以保证在小屏幕上的可读性。

使用合理的格式,不要太偏离 Rust 语言社区使用的通用惯例。我并不严格执行,没有必要使用 rustfmt。如果偏离这些标准可以使代码在书中得到更好的呈现,那么这样做是可取的。

文字风格

使之易于阅读。

  • 简要。尽量涵盖所有重要的信息,不做冗长的解释。
  • 倾向于使用简单的词组和短句子。
  • 避免信息过载。
    • 把事情分成简短的段落。
    • 避免同时介绍许多(即使是相关的)主题。
    • 将高级用法与基础知识分开介绍。