Skip to content

Commit 3d55f29

Browse files
committed
Create CONTRIBUTING.md
1 parent 98ab577 commit 3d55f29

File tree

1 file changed

+76
-0
lines changed

1 file changed

+76
-0
lines changed

CONTRIBUTING.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
如果您对开源感兴趣且愿意学习和贡献,欢迎您共建 Solon 生态。
2+
3+
### 1、版权说明
4+
5+
本仓库的源码版权归 noear 开源组织所有.
6+
7+
### 2、贡献分类
8+
9+
代码贡献:
10+
11+
* 修复问题或优化现有的代码
12+
* 新增功能插件
13+
* 添加 Solon Cloud 适配插件
14+
* 为现有的模块丰富单元测试用例;为官网丰富配套示例。等...
15+
16+
合作贡献:
17+
18+
* 有开源框架的同道,在自己仓库里添加 solon 框架的便利适配(需要帮忙随时联系交流)
19+
* 基于 Solon 开发开源项目或框架。等...
20+
21+
其它贡献:
22+
23+
* 通过 Issue,提交需求、提交问题
24+
* 发博客宣传、录视频界面、在交流群或社区推荐 Solon。等...
25+
26+
27+
### 3、代码贡献说明
28+
29+
1. 提交 Issue ,并与管理员进行确认(避免重复工作)
30+
2. Fork 仓库
31+
3. 在 dev 分支上编写代码,并添加对应的单元测试
32+
4. 统一使用 solon-test-junit5 做单测(为了批量跑单测)
33+
5. pr 时,选择 dev 分支进行合并(提交时需关联一个 Issue)
34+
6. 如果是分布式中间件的适配,优先适配成 solon cloud 规范
35+
7. 注释多些点:)
36+
37+
### 4、代码分支保护规则说明
38+
39+
40+
41+
42+
| 操作 | master (or main) | dev |
43+
| -------- | -------- | -------- |
44+
| 可推送代码成员 | 禁止任何人 | 仓库管理员 |
45+
| 可合并 Pull Request 成员 | 禁止任何人 | 仓库管理员 |
46+
47+
48+
49+
50+
### 5、代码模块测试目上录结构规范说明
51+
52+
| 目录 | 说明 |
53+
|--------------------|-----------------------|
54+
| src/test/benchmark | 压测目录(可选) |
55+
| src/test/demo | 简单示例目录(必须,只是看看的放这里) |
56+
| src/test/features | 特性测试目录(必选,会进入全项目批量单测) |
57+
| src/test/labs | 实验目录(可选,不能批量跑的单测) |
58+
59+
不要增加别的目录
60+
61+
62+
### 6、主要代码仓库说明
63+
64+
65+
| 仓库 | 说明 |
66+
| -------- |----------------------------------|
67+
| https://gitee.com/noear/solon | Solon 主仓库 |
68+
| https://gitee.com/noear/solon-examples | Solon 官网配套示例仓库 |
69+
| | |
70+
| https://gitee.com/dromara/solon-plugins | Solon 第三方扩展插件仓库 |
71+
| | |
72+
| https://gitee.com/noear/solon-admin | Solon Admin 代码仓库 |
73+
| https://gitee.com/noear/solon-jakarta | Solon Jakarta 代码仓库(采用 java11 编译) |
74+
| https://gitee.com/noear/solon-integration | Solon Integration 代码仓库 |
75+
| | |
76+
| https://gitee.com/noear/solon-idea-plugin | Solon Idea 插件代码仓库 |

0 commit comments

Comments
 (0)