向 ClassIsland 文档做贡献

注意

本文章是面向 ClassIsland 文档 贡献者的贡献指南。如果您要为 ClassIsland 本体 做出贡献，请参阅 ClassIsland 贡献指南。

本文档的建设离不开广大用户的支持，感谢您考虑为本文档做出贡献❤️！在为本文档贡献之前，请先阅读本指南。

本文档基于 VuePress 搭建。了解 VuePress 的用法对编写本文档很有帮助。

本文档目前托管在 GitHub Pages 上。

贡献准则

• 使用小写文件名

  VuePress 对 URL 链接大小写敏感，使用包含大写字母的文件名可能会出现一些问题。在命名文档和文件夹时请使用小写字母，并用-分割每个单词，例如：

  example-doc.md
  example-folder/
      |- another-doc.md

• 将图片放置在仓库文件中

  插入图片时请尽量直接将源文件插入到仓库文件中，不使用额外的 CDN / 图床承载图片，以便发布文档时自动将图片等文件打包到 GitHub Pages 上。插入的图片请放置在 (文档目录)/image/(文档文件名)下，例如：

  example-doc.md
  example-doc-2.md
  image/
      |- example-doc/
      |   |- image1.png
      |   |- image2.png
      |- example-doc-2/
          |- image1.png
          |- image2.png

• 编写简单易读的文档

  在编写文档时请尽量做到简单易读。必要时可以插入图片、Mermaid 图表等便于读者理解。

合并更改

您可以向本项目发起 Pull Request 来合并您的更改。在发起 Pull Request 时，请简要地描述您做的更改。

更改合并以后，您可以在 最新版文档 中看到您的更改。

还有疑问？

您可以加入 QQ 群与开发者和其他用户讨论。