开发规范

本规范对你的编码风格不做要求。

用语介绍

本规范部分用语的介绍。

能愿动词

一般会被加粗显示。

必须:强制性规范。你必须完全遵从该条规范。

应该:建议性规范。我们建议你遵从该条规范。

命名

该规范适用范围为:插件命名空间(即 package.json 中 name 值)及 Git 仓库名。

你的插件命名必须采用 kebab-case 命名风格。

你的插件命名应该使用 qwqnt 开头。

你的插件命名应该简洁明了地突出主要功能。

如:qwqnt-example-plugin 或 example-plugin。

文档

该规范适用范围为:README 文档及其他的说明文档。

你的插件的说明文档必须包括简单的功能说明。

你的插件的说明文档必须包括所有的前置插件(如果有)。

你的插件的说明文档应该写明使用的开源协议。

仓库

该规范适用范围为:插件的 Git 仓库。

你的插件的 Git 仓库必须可被审计,不允许完全闭源。

你的插件的 Git 仓库必须拥有反馈渠道(可使用平台提供的渠道或自留渠道)。

你的插件的 Git 仓库必须存储插件的所有代码。

你的插件的 Git 仓库必须拥有可维护的提交记录。

你的插件的 Git 仓库必须公开,在未开发完毕的情况下可暂时设为私有,但开发完成后应公开。 部分特殊的插件经管理组审核后可以设置为私有,但需要保持管理组内至少一人拥有该仓库的 Read 权限。

你的插件的 Git 仓库必须可以自动化且公开地构建插件,且构造产物必须与使用手动使用仓库代码构建的产物一致。

你的插件的 Git 仓库应该采用明确地采用任意开源协议。

贡献者

Powered by Valaxy