Skip to content

Commit 1d3c7e9

Browse files
noearnoear
committed
Create CONTRIBUTING.md
1 parent 14392ed commit 1d3c7e9

1 file changed

Lines changed: 102 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
如果您对开源感兴趣且愿意学习和贡献，欢迎您共建 Solon 生态。
2+
3+
### 1、版权说明
4+
5+
本仓库的源码版权归 noear 开源组织所有。
6+
7+
### 2、贡献分类
8+
9+
代码贡献：
10+
11+
* 修复问题或优化现有的代码
12+
* 新增功能插件
13+
* 添加 Solon AI、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. 在 main 分支上编写代码，并添加对应的单元测试
32+
4. 统一使用 solon-test 做单测（为了批量跑单测）
33+
5. pr 时，选择 main 分支进行合并（提交时需关联一个 Issue）
34+
6. 如果是分布式中间件的适配，优先适配成 solon cloud 规范
35+
7. 注释多些点：）
36+
37+
### 4、代码分支保护规则说明
38+
39+
40+
| 操作 | main |
41+
|----------------------|---------|
42+
| 可推送代码成员 | 禁止任何人 |
43+
| 可合并 Pull Request 成员 | 仓库管理员 |
44+
45+
46+
47+
48+
### 5、代码模块测试目上录结构规范说明
49+
50+
| 目录 | 说明 |
51+
|--------------------|-----------------------|
52+
| src/test/benchmark | 压测目录（可选） |
53+
| src/test/demo | 简单示例目录（必须，只是看看的放这里） |
54+
| src/test/features | 特性测试目录（必选，会进入全项目批量单测） |
55+
| src/test/labs | 实验目录（可选，不能批量跑的单测） |
56+
57+
不要增加别的目录
58+
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 第三方扩展插件代码仓库 |
102+

0 commit comments

Comments
 (0)