GoFrame 贡献指南

[gqcn]

GoFrame贡献指南

欢迎来到开源摘星计划 - GoFrame贡献专栏 。GoFrame已加入开源摘星计划，该计划提供奖励以鼓励你加入我们的社区：所有参与本项目贡献的开发者都可获得相应贡献积分、奖励以及被评选为年度摘星 100 人的机会，活动及奖励详情请见：开源摘星计划。

📅 活动时间：2022年5月-12月

🌟关于 GoFrame

GoFrame是一款模块化、高性能、企业级的Go基础开发框架。GoFrame不是一款WEB/RPC框架，而是一款通用性的基础开发框架，是Golang标准库的一个增强扩展级，包含通用核心的基础开发组件，优点是实战化、模块化、文档全面、模块丰富、易用性高、通用性强、面向团队。

如果您想使用Golang开发一个业务型项目，无论是小型还是中大型项目，GoFrame是您的不二之选。如果您想开发一个Golang组件库，GoFrame提供开箱即用、丰富强大的基础组件库也能助您的工作事半功倍。

特点

• 业内领先、工程完备
• 模块化、松耦合设计
• 组件丰富、开箱即用
• 简洁易用、文档详尽
• 接口化、高扩展性设计
• 全链路跟踪特性
• 全错误堆栈特性
• 接口化的错误码支持
• 稳健的工程设计规范
• 更便捷强大的ORM组件
• 便捷的开发工具、自动化代码生成
• 支持OpenTelemetry可观测性标准
• 自动化的接口文档生成，支持OpenAPIV3标准
• 完善的本地中文化支持
• 设计为团队及企业使用

架构

以下是项目可参与的方向：

1. 我们列出了适合首次加入 GoFrame 社区的贡献者的问题、适合对项目有足够了解的贡献者的特殊 issue 挑战（参见下面的列表）以及一些社区日常任务。如果你愿意解决，请点击该 issue 并在评论区留言 WeOpen Star（日常及其他任务无需此操作）。提交 PR 时，请同时将 PR 链接到相应的 issue。

2. 对于成功完成任意任务的贡献者，为记录你的积分以及发放奖励，请自行前往你的积分主页记录。积分记录规则详见：关于积分。

在开始贡献之前：

• 请加入【开源摘星计划】社群

  请添加官方小助手微信（微信号：TCOSOO1）

• 建议你通读我们的贡献指南

  GoFrame项目贡献指南

🌟 我们对贡献任务进行了分类，以帮助你找到你感兴趣的任务

社区日常任务

积分奖励：1分/个

• 参与项目例会
• 提交 Issue/Comment

在Issue回答以帮助社区小伙伴：https://github.com/gogf/gf/issues

文档类

积分奖励：10分/个

英文文档编写：将中文翻译为英文文档，便于项目国际化。

• 英文文档（任务）：https://goframe.org/pages/viewpage.action?pageId=47699021
• 中文文档（参考）：https://goframe.org/pages/viewpage.action?pageId=1114119

其中，英文文档我们已经组织了基本的文档结构，大家按照结构填充内容即可。由于中文文档比较多且结构比较细，英文文档的结构也请参考中文文档的结构来，大家也有权限创建子级页面。一篇文档算一次任务。

推荐使用google翻译工具：https://translate.google.cn/

工具翻译后，人工调整语法及个别用词。

编程类

积分奖励：50分/个

按照项目需求的优先级，我们整理了以下任务：

1. 单元测试完善：contrib/drivers/pgsql
2. 单元测试完善：contrib/drivers/mssql
3. 单元测试完善：contrib/drivers/sqlite
4. 单元测试完善：contrib/drivers/clickhouse
5. 数据库DB Driver贡献 新增一个数据库类型算一次任务。具体见详情
6. 组件单测代码覆盖率 每个组件覆盖率到80%以上，一个组件算一次任务，具体见详情。
7. Help Wanted Issues 一个help wanted issue算一次任务，欢迎贡献PR。

其他类

开源知识分享官：提交对本项目的学习笔记或开源相关笔记（视频/文章皆可）并发布在任意社区/博客/视频平台即可申报积分。

积分奖励：10分

额外奖励：每月将为10名优秀笔记作者奖励QQ周边公仔、QQ音乐/腾讯视频年卡及腾源会T恤等好礼。

贡献帮助

对参与GoFrame项目贡献的小伙伴，请联系微信：389961817 备注：GoFrame贡献