goKit

README

goKit

一个用于偷懒少写代码的工具类

👉 https://xingcxb.com 👈

---

🫡 向hutool致敬

📚简介

goKit是一个小而全的Go工具类库，通过将常用方法封装，降低相关API的学习成本，提高工作效率(😏主要是偷懒)，少干重复的活。

goKit能节省了开发人员对项目中公用类和公用工具方法的封装时间，使开发专注于业务，同时可以最大限度的避免封装不完善带来的bug。

⚠️ 注意事项

• 本项目为开源兴趣项目，使用时请自行验证问题，生产环境自己测试

🎁goKit名称的由来

goKit = go + kit，go表示语言；kit表示工具包。就粗暴的直译为go的工具包

🍺goKit如何改变我们的coding方式

goKit的目标是使用一个工具方法代替一段复杂代码，从而最大限度的避免“复制粘贴”代码的问题，彻底改变我们写代码的方式。

🛠️包含组件

一个Go基础工具文件，对文件、流、加密解密、转码、正则、线程、XML等方法进行封装，组成各种工具文件，同时提供以下组件：

📦安装

  go get https://github.com/xingcxb/goKit

🔔️注意：goKit支持1.20+

🏗️添砖加瓦

🎋分支说明

goKit的源码分为两个分支，功能如下：

分支	作用
master	主分支，不接收任何pr或修改
dev	开发分支，默认为下个版本的正式版本，接受修改或pr

吐槽

关于注释的解释

在goland中多行注释折叠时会导致完全看不见，让我不太舒服，所以第一行标准写法，参数只能是参考Java注释来了，话说意外的算好用

🐞提供bug反馈或建议

提交问题反馈请说明正在使用的Go版本呢、goKit版本和相关依赖库版本。

• Github issue

🧬 贡献代码的步骤

1. 在Github上fork项目到自己的repo
2. 把fork过去的项目也就是你的项目clone到你的本地
3. 修改代码（记得一定要修改v5-dev分支）
4. commit后push到自己的库（v5-dev分支）
5. 登录Github在你首页可以看到一个pull request按钮，点击它，填写一些说明信息，然后提交即可。
6. 等待维护者合并

📐PR遵照的原则

goKit欢迎任何人为goKit添砖加瓦，贡献代码，不过维护者是一个强迫症患者，为了照顾病人，需要提交的pr（pull request）符合一些规范，规范如下：

1. 注释完备，尤其每个新增的方法应按照Java文档规范标明方法说明、参数说明、返回值说明等信息，必要时请添加单元测试，如果愿意，也可以加上你的大名。
2. goKit的缩进按照IDEA默认（tab）缩进，所以请遵守（不要和我争执空格与tab的问题，这是一个病人的习惯）。
3. 新加的方法不要使用第三方库的方法，goKit尽量遵循无依赖原则（除非偷懒的情况）。
4. 请pull request到dev分支。master是主分支，表示已经发布中央库的版本，这个分支不允许pr，也不允许修改。
5. 我们如果关闭了你的issue或pr，请不要诧异，这是我们保持问题处理整洁的一种方式，你依旧可以继续讨论，当有讨论结果时我们会重新打开。

---

⭐Star goKit

📜License

MIT 许可证 LICENSE ©️ 2023 xingcxb

🙏 感谢