自己造轮子是一件苦差事。 现在,您可以专注于业务开发,仅需集成 ⭐️Furion⭐️ 即可。
Skip to main content

38. 贡献指南

提交错误报告

如果您在 XXX 中发现了一个不存在安全问题的漏洞,请在 XXX 仓库中的 Issues 中搜索,以防该漏洞已被提交,如果找不到漏洞可以创建一个新的 Issues,如果发现了一个安全问题请不要将其公开,请参阅安全问题处理方式,提交错误报告时应该详尽。

安全问题处理

本项目中对安全问题处理的形式,项目核心人员确认编辑,该部分内容可以根据项目情况添加。

解决现有问题

通过查看仓库的 Issues 列表可以发现需要处理的问题信息,可以尝试解决其中的某个问题。

如何提出新功能

提出新功能有些项目使用 Issues 的 Feature 标签进行管理,有些则通过邮件的形式统一收集,在收集后项目内人员会进行确认开发,一般将确认开发的功能会放入下一个版本的任务列表。

如何设置开发环境并运行测试

如果是通过 Git 管理可以从 git clone xxx 开始编写,将开发环境的配置信息,IDE 的设置等信息配置文档编写。

变更日志填写规则

  1. 使用现在时态
  2. 第一行字数限制
  3. 提交内容的约束

编码约定

  • 项目内编码约定文件:.editorconfig

分支处理约定

  • 分支处理形式,如 gitFlow

合并 PR 的形式

在什么情况下可以合并到 master/main:

  1. 通过 CI
  2. 两个及以上的维护者通过.
  3. 最新版本
演练场