Solon v2.8.4

参与贡献指南

</> markdown

如果您对开源感兴趣且愿意学习和贡献,欢迎您共建 Solon 生态。

1、版权说明

solon 及相关仓库的源码版权归 noear 开源组织所有。关于代码方面:

  • 目前有充分授权给,开放原子开源基金会
  • 提交 pr 时需签署 cla 开源协议

2、贡献分类

代码贡献:

  • 修复问题或优化现有的代码
  • 新增功能插件
  • 添加 Solon Cloud 适配插件
  • 为现有的模块丰富单元测试用例;为官网丰富配套示例。等...

合作贡献:

  • 有开源框架的同道,在自己仓库里添加 solon 框架的便利适配(需要帮忙随时联系交流)
  • 基于 Solon 开发开源项目或框架。等...

其它贡献:

  • 通过 Issue,提交需求、提交问题
  • 发博客宣传、录视频界面、在交流群或社区推荐 Solon。等...

3、代码贡献说明

  1. 提交 Issue ,并与管理员进行确认(避免重复工作)
  2. Fork 仓库
  3. 在 dev 分支上编写代码,并添加对应的单元测试
  4. 统一使用 solon-test-junit5 做单测(为了批量跑单测)
  5. pr 时,选择 dev 分支进行合并(提交时需关联一个 Issue)
  6. 如果是分布式中间件的适配,优先适配成 solon cloud 规范
  7. 注释多些点:)

4、代码分支保护规则说明

操作master (or main)dev
可推送代码成员禁止任何人仓库管理员
可合并 Pull Request 成员禁止任何人仓库管理员

5、代码模块测试目上录结构规范说明

目录说明
src/test/benchmark压测目录(可选)
src/test/demo简单示例目录(必须,只是看看的放这里)
src/test/features特性测试目录(必选,会进入全项目批量单测)
src/test/labs实验目录(可选,不能批量跑的单测)

不要增加别的目录

6、主要代码仓库说明

代码仓库描述
https://gitee.com/opensolon/solonSolon ,主代码仓库
https://gitee.com/opensolon/solon-examplesSolon ,官网配套示例代码仓库
https://gitee.com/opensolon/solon-cloudSolon Cloud ,代码仓库
https://gitee.com/opensolon/solon-adminSolon Admin ,代码仓库
https://gitee.com/opensolon/solon-jakartaSolon Jakarta ,代码仓库(base java17)
https://gitee.com/opensolon/solon-integrationSolon Integration ,代码仓库
https://gitee.com/opensolon/solon-gradle-pluginSolon Gradle ,插件代码仓库
https://gitee.com/opensolon/solon-idea-pluginSolon Idea ,插件代码仓库
https://gitee.com/opensolon/solon-vscode-pluginSolon VsCode ,插件代码仓库
https://gitee.com/dromara/solon-pluginsSolon 第三方扩展插件代码仓库