Skip to content

Latest commit

 

History

History
80 lines (51 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

80 lines (51 loc) · 2.17 KB

贡献须知

开发之前

你可以选择你喜欢的包管理器安装依赖。

但是需要注意的是,安装依赖之后会自动预构建。你需要删除自动构建的目录 /dist

为了开发时的加载速度,添加了一个/js/**/*项的构建,建议您将src/app/js链接到js

在本地调试项目时,你需要同时运行 npm run servenpm run serve:css,前者为网页服务(需要登录 Vercel ),后者为 css 服务。

新增收录软件

你需要在 /src/software/ 底下的三个文件夹分别新建以 id 为文件名的文件。

id 只应该包含小写字母、数字以及连字符-

各文件的格式可以看边上的例子。

当然,你也可以把你自己开发的东西放上来!我们也支持这样的行为!大家都是个人开发者,相互包容咯。

提交信息规范

提交信息需要满足以下格式

<类型>[可选 范围]: <描述>

[可选 正文]

[可选 脚注]

其中,类型可以选择这些:

Feat    表示新增了一些东西;
Fix     表示修复了一些问题;
Build   表示修改了依赖;
Ci      表示修改了自动构建部署脚本;
Docs    表示修改了文档\(包括README\);
Perf    表示该提交针对性能进行了优化;
Refactor表示重构了一些部分;
Revert  表示回滚了版本;
Chore   表示更改了构建过程或辅助工具;
Res     表示修改了资源。

对于破坏性的修改,需要在类型后加上!,比如Fix! (Backend): 修改了解析接口

范围包括这些:

Backend 表示后端;
UI      表示前端;
Fish    表示收录的软件;

CI 什么的不需要写范围了,类型里面就有了。

提交信息内容请尽量使用中文。

Pull Request

对于这几种修改,需要预先发 Issue 确认以避免不必要的时间成本损失:

  • 修改或重构后端;
  • 增加新功能;
  • 修复问题。

对于这几种修改,可以不预先发 Issue 而直接提 PR:

  • 增加收录的软件;
  • 修正收录信息;
  • 修改文档。

最终解释权归我本人所有。

让人看着不爽的 PR 我会选择直接 close。