如何贡献
2024年8月20日大约 4 分钟
如何贡献
参与贡献
为开源项目点一个Star
Star的多少关系到项目能否被更多人看到
同时Star也是作者前进的动力(作者每天都在盯着Star 涨了会开心 跌了会失落)
大家在寻找开源项目的时候, 大多数情况也是会先看Star比较多的项目
所以请给您觉得好的开源项目点一个小小的Star, 让好的项目能够被更多人看到
github地址 | gitee地址 | gitCode地址
为社区处理问题
- Issue是社区的交流地 大家会在这里提出自己的问题 或者是项目的功能异常
- 提问的规范在Issue的模板里已经写好了 按照模板填写有助于作者或者其他社区人员快速有效的回答问题
- 为提出问题的小伙伴答疑 可以有效降的帮助别人
- 而且可以降低社区人员的精力分散 使精力全部投入到项目设计研发中
改进社区文档:文档仓库
大家都知道 我们程序员都不擅长写作
有时候作者把文档写完了也不知道用户是什么感觉 是否能看懂
所以参与社区文档建设绝对是一件意义重大的事情
大家可以在Issue提出观后感 觉得哪看不懂 觉得哪应该详细说明
当然了 大家也可以对文档进行改进后提交PR修改申请
贡献代码
想参与贡献代码的小伙伴 重点来了: 作者会经常在Issue里发布需求认领
觉得自己能做的可以在Issue里跟作者讨论 如需求还不够清晰 或者做的过程中遇到了什么问题
需求确定了以后就可以开始专注的写代码了
但在开始写代码之前 一定要先看一下如何正确的提交PR
如何成为项目贡献者
1.对框架有重大贡献者(由作者与团队成员判定)
2.完成社区发布的两项复杂任务
3.持续完成社区发布的简单任务若干(作者会关注到)
4.持续为社区优化文档或处理issue若干(作者会关注到)
项目贡献者待遇
1.捐献红包和群主不定时红包
2.每年还会发放IDEA正版授权,视情况而定
提交pr
步骤一 Fork项目到自己仓库
步骤二 基于dev分支 新建一个此PR功能点的专属分支
步骤三 使用Git工具 将自己仓库的项目拉去到本地做代码编写
步骤四 使用Idea打开项目 切换到新建的功能分支
步骤五 设置创建类的模板
新创建的类使用这个模板生成注释,使用方式在类上面写上 /c
,然后按回车会自动生成
步骤六 将编写好的代码 提交到自己的远程仓库
git提交规范
[init] 初始化
[feat] 增加新功能
[fix] 修复问题/BUG
[perf] 优化/性能提升
[refactor] 重构
[revert] 撤销修改
[style] 代码风格相关无影响运行结果的
[update] 其他修改
[upgrade] 升级版本