Skip to content

Commit 3b3104e

Browse files
noearnoear
committed
Update CONTRIBUTING.md
1 parent 4c06f57 commit 3b3104e

1 file changed

Lines changed: 52 additions & 26 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 52 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
### 1、版权说明
44

5-
本仓库的源码版权归 noear 开源组织所有.
5+
本仓库的源码版权归 noear 开源组织所有。
66

77
### 2、贡献分类
88

99
代码贡献：
1010

1111
* 修复问题或优化现有的代码
1212
* 新增功能插件
13-
* 添加 Solon Cloud 适配插件
13+
* 添加 Solon AI、Solon Cloud 等适配插件
1414
* 为现有的模块丰富单元测试用例；为官网丰富配套示例。等...
1515

1616
合作贡献：
@@ -28,21 +28,19 @@
2828

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

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

3939

40-
41-
42-
| 操作 | master (or main) | dev |
43-
| -------- | -------- | -------- |
44-
| 可推送代码成员 | 禁止任何人 | 仓库管理员 |
45-
| 可合并 Pull Request 成员 | 禁止任何人 | 仓库管理员 |
40+
| 操作 | main |
41+
|----------------------|---------|
42+
| 可推送代码成员 | 禁止任何人 |
43+
| 可合并 Pull Request 成员 | 仓库管理员 |
4644

4745

4846

@@ -58,19 +56,47 @@
5856

5957
不要增加别的目录
6058

59+
### 6、代码提前描述的前缀规范
60+
61+
62+
| 前缀 | 示例 | 说明 |
63+
|----|---------------------------------------|------------------|
64+
| 新增 | 新增 solon-xxx 模块 | 表示增加一个全新模块 |
65+
| 添加 | 添加 solon-xxx Yyy 工具类 | 表示在一个模块里增加新的能力 |
66+
| 优化 | 优化 solon-xxx Yyy 延尽订阅处理逻辑 | 表示优化现有代码（没有兼容风险） |
67+
| 修复 | 修复 solon-xxx Yyy 无法读取元数据问题 | 表示修复现有问题（没有兼容风险） |
68+
| 调整 | 调整 solon-xxx Yyy 默认值为 true（之前为 false） | 表示调整现有代码（会有兼容风险） |
69+
| 移除 | 移除 solon-xxx Yyy 注解类（之前已弃用一年） | 表示移除多余的类 |
70+
| 文档 | 文档 solon-xxx Yyy 的注释完善 | 表示文档相关的完善 |
71+
| 测试 | 测试 solon-xxx 补充 Yyy 测试用例 | 表示测试相关的完善 |
72+
| 其它 | 其它 solon-xxx 配置示例变化 | 其它相关内容 |
73+
74+
75+
### 7、主要代码仓库说明
76+
77+
78+
| 代码仓库 | 描述 |
79+
|-------------------------------------------------|----------------------------------|
80+
| https://gitee.com/opensolon/solon | Solon ,主代码仓库 |
81+
| https://gitee.com/opensolon/solon-examples | Solon ,官网配套示例代码仓库 |
82+
| | |
83+
| https://gitee.com/opensolon/solon-ai | Solon Ai ,代码仓库 |
84+
| https://gitee.com/opensolon/solon-flow | Solon Flow ,代码仓库 |
85+
| https://gitee.com/opensolon/solon-expression | Solon Expression ,代码仓库 |
86+
| https://gitee.com/opensolon/solon-cloud | Solon Cloud ,代码仓库 |
87+
| https://gitee.com/opensolon/solon-admin | Solon Admin ,代码仓库 |
88+
| https://gitee.com/opensolon/solon-integration | Solon Integration ,代码仓库 |
89+
| https://gitee.com/opensolon/solon-java17 | Solon Jakarta ,代码仓库（base java17） |
90+
| https://gitee.com/opensolon/solon-java25 | Solon Jakarta ,代码仓库（base java25） |
91+
| | |
92+
| https://gitee.com/opensolon/soloncode | SolonCode(Java8 impl version of "Claude Code") ,Code repository |
93+
| https://gitee.com/opensolon/solonclaw | SolonClaw(Java8 impl version of "OpenClaw") ,Code repository |
94+
| | |
95+
| https://gitee.com/opensolon/solon-maven-plugin | Solon Maven ,插件代码仓库 |
96+
| https://gitee.com/opensolon/solon-gradle-plugin | Solon Gradle ,插件代码仓库 |
97+
| | |
98+
| https://gitee.com/opensolon/solon-idea-plugin | Solon Idea ,插件代码仓库 |
99+
| https://gitee.com/opensolon/solon-vscode-plugin | Solon VsCode ,插件代码仓库 |
100+
| | |
101+
| https://gitee.com/dromara/solon-plugins | Solon 第三方扩展插件代码仓库 |
61102

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)