CONTRIBUTING.md

贡献指北

目录结构

/assets/: 存放附加的 javascript 和 CSS 文件。 /home/: 存放 WeDot 文档网页主页。 /override/: 存放文档编译后用来覆盖已编译文件的文件。 /scripts/: 实用脚本。 /src/: 文档源文件。WeDot 文档网页中的所有内容都在这里。 /theme/: 网页的主题相关文件。 /book.toml: 配置文件。 /build.bash: 构建总脚本。

项目版本管理

本仓库版本跟随 WeDot 引擎提升。

提交信息格式

提交信息应遵循 PJ568 提交说明规范。

范围

类别	描述
关于	与文档的“关于”部分和其他文章相关的合并请求。
类引用	问题与类引用相关，而不是文档页面。
社区	与文档的社区部分相关的合并请求。
贡献	与文档的贡献或开发部分相关的合并请求。
入门	与文档的入门部分相关的合并请求。
手册	与文档的手册或教程部分相关的合并请求。

提交更改

暂定：以下参考尚未完善。

1. 确保您已安装 mdbook；
2. Fork 此仓库，对文档或代码进行更改，并检查语法是否存在任何问题；
3. 在仓库下执行 mdbook build && mdbook test、mdbook serve 命令，检查生成的 HTML 是否存在任何问题；
4. 将更改推送到您的分支，并向我们的仓库提交拉取请求；
5. 我们将定期审查拉取请求，并告知您我们的问题以及在合并您的拉取请求之前需要进行的任何更改；
6. 请您在 15 日内作出回应，之后若没有活动，您的拉取请求可能会被关闭；