如何贡献代码
# 🐞提供bug反馈或建议
提交问题反馈请说明正在使用的JDK版本、stream-query版本和相关依赖库版本。如果可以请尽量详细或加图片以便于我们去复现
Gitee issue (opens new window)
Github issue (opens new window)
# 🏗️添砖加瓦️
如果您感觉我们的代码有需要优化的地方或者有更好的方案欢迎随时提pr
# 📚包说明
包名 | 内容 |
---|---|
stream-query | 优雅的流式操作 |
stream-plugin | orm框架->使用优雅的Lambda进行对数据库进行一系列操作 |
# 🐾贡献代码的步骤
- 在
Gitee
或者Github
上fork
项目到自己的repo
- 把
fork
过去的项目也就是你的项目clone
到你的本地 - 修改代码
commit
后push
到自己的库- 登录
Gitee
或Github
在你仓库首页可以看到一个pull request
按钮,点击它,填写一些说明信息,然后提交即可。 等待维护者合并
# 📐PR遵照的原则
stream-query
欢迎任何人为stream-query
添砖加瓦,贡献代码,规范如下:
- 注释完备,尤其每个新增的方法应按照Java文档规范标明方法说明、参数说明、返回值说明等信息,必要时请添加单元测试,如果愿意,也可以加上你的大名。
- 新加的方法尽可能不要使用额外的第三方库方法
- 我们如果关闭了你的issue或pr,请不要诧异,这是我们保持问题处理整洁的一种方式,你依旧可以继续讨论,当有讨论结果时我们会重新打开。
上次更新: 2024/03/29, 09:17:32