CONTRIBUTING.md · Andy___feiyang/socket.d - Gitee

forked from noear/socket.d

Create your Gitee Account

Explore and code with more than 12 million developers，Free private repositories ！：）

文件

Clone or Download

CONTRIBUTING.md 1.66 KB

Copy Edit Raw Blame History

authored 2023-11-28 17:34 . Create CONTRIBUTING.md

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


### 1、贡献分类

代码贡献：

* 修复问题或优化现有的代码
* 添加新的语言或平台的适配
* 为现有的模块丰富单元测试用例；为官网丰富配套示例。等...

合作贡献：

* 有开源框架的同道，在项目里使用 socket.d 框架或便利适配（需要帮忙随时联系交流）
* 等...

其它贡献：

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


### 2、代码贡献说明

1. 提交 Issue ，并与管理员进行确认（避免重复工作）
2. Fork 仓库
3. 在 dev 分支上编写代码，并添加对应的单元测试
4. 统一使用 junit5 做单测（为了批量跑单测）
5. pr 时，选择 dev 分支进行合并（提交时需关联一个 Issue）
6注释多些点：）

### 3、代码分支保护规则说明




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




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

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

不要增加别的目录

Loading...

马建仓 AI 助手

尝试更多

代码解读

代码找茬

代码优化

Java

1

https://gitee.com/andyfeiyang/socket.d.git

git@gitee.com:andyfeiyang/socket.d.git

andyfeiyang

socket.d

socket.d

main