6.6 KiB
Contributing
我们提倡您通过提 Issue 和 Pull Request 方式来促进 APIJSON 的发展。
Acknowledgements
非常感谢以下贡献者们对于 APIJSON 本项目做出的贡献：
- TommyLemon(腾讯工程师，还开源了 apijson-framework, APIJSON-Demo, apijson-column 等)
- ruoranw(现居美国洛杉矶，还开源了 APIJSONdocs)
- zhoulingfengofcd
- Zerounary(还开源了 APIJSONParser)
- fineday009(腾讯工程师，还贡献了 apijson-framework, APIJSON-Demo)
- vincentCheng(还开源了 apijson-doc)
- justinfengchen
- linlwqq
- redcatmiss(社保科技工程师)
- linbren
- jinzhongjian
- CoolGeo2016
- 1906522096
- github-ganyu
- sunxiaoguang(知乎基础研发架构师)
- 403f
- gujiachun
- gdjs2
- Rkyzzy(SUSTech)
- kxlv2000(SUSTech)
- caohao-php(腾讯工程师)
- Wscats(腾讯工程师)
- jun0315(腾讯工程师)
- JieJo
- yeyuezhishou(圆通工程师)
- kenlig(还开源了 apijsondocs)
- andream7(还开源了 apijson-db2)
- qiujunlin(还开源了 APIJSONDemo)
- HANXU2018(还开源了 APIJSON-DOC)
- hclown9804
- chenyanlann(还开源了 APIJSONDemo_ClickHouse)
- haolingzhang1(腾讯工程师，还开源了 APIJson--demo)
- jerrylususu(还开源了 apijson_todo_demo 和 apijson_role_extend)
- Dalezee(还开源了 apijson_camp)
- aaronlinv
其中特别致谢:
justinfengchen 提交的 6 个 Commits, 对 APIJSON 做出了 3,130 增加和 0 处删减(截止 2020/11/04 日)；
ruoranw 提交的 18 个 Commits, 对 APIJSON 做出了 328 增加和 520 处删减(截止 2020/11/04 日)；
Zerounary 提交的 6 个 Commits, 对 APIJSON 做出了 1,104 增加和 1 处删减(截止 2020/11/04 日)。
APIJSON 持续招募贡献者，即使是在 Issue 中回答问题，或者做一些简单的 Bug Fix ，也会给 APIJSON 带来很大的帮助。
APIJSON 已开发近 4 年，在此感谢所有开发者对于 APIJSON 的喜欢和支持，希望你能够成为 APIJSON 的核心贡献者，
加入 APIJSON ，共同打造一个更棒的自动化 ORM 库！🍾🎉
为什么一定要贡献代码？
APIJSON 作为腾讯开源的知名热门项目，贡献代码除了可以给简历加亮点、为面试加分，还可以避免你碰到以下麻烦：
1.你在 APIJSON 上更改的代码其他人看不到，不能帮你发现 Bug，更不可能帮你修复 Bug 甚至优化代码
2.作者和其它贡献者可能不兼容你更改的代码，导致你的项目在升级 APIJSON 版本后在功能甚至编译上出错
3.你需要自己维护你的代码，每次升级 APIJSON 版本时，你都需要下载 APIJSON 新代码再合并你自己的更改
所以为了让你自己的更改始终能跟上项目版本，得到他人给予的可靠且持续的维护，强烈建议 提交 Pull Request 来贡献代码。
Issue 提交
对于贡献者
在提 Issue 前请确保满足一下条件：
- 必须是一个 Bug 或者功能新增。
- 必须是 APIJSON 相关问题。
- 已经在 Issue 中搜索过，并且没有找到相似的 Issue 或者解决方案。
- 完善下面模板中的信息
如果已经满足以上条件，我们提供了 Issue 的标准模版，请按照模板填写。
Pull Request
我们除了希望听到您的反馈和建议外，我们也希望您接受代码形式的直接帮助，对我们的 GitHub 发出 Pull Request 请求。
如果是小改文档或代码
直接点文件右上角的编辑图标按钮
然后底部简要输入修改说明，点击 Commit Change 按钮
如果有比较大的改动
以下是具体步骤：(如果使用本步骤，GitHub 可能不会把贡献者添加到 Contributors 中，推荐用以下 详细的图文步骤)
Fork 仓库
点击 Fork 按钮，将需要参与的项目仓库 Fork 到自己的 Github 中。
Clone 已 Fork 项目
在自己的 Github 中，找到 Fork 下来的项目，git clone 到本地。
$ git clone git@github.com:<yourname>/APIJSON.git
添加 APIJSON 仓库
将 Fork 源仓库连接到本地仓库：
$ git remote add <name> <url>
# 例如：
$ git remote add APIJSON git@github.com:Tencent/APIJSON.git
保持与 APIJSON 仓库的同步
直接在 fork Repo 的首页点 Contribute > Open pull request
或者
$ git pull --rebase <name> <branch>
# 等同于以下两条命令
$ git fetch <name> <branch>
$ git rebase <name>/<branch>
Commit 信息提交
Commit 信息请遵循 Commit 消息约定，以便可以自动生成 CHANGELOG 。具体格式请参考 Commit 文档规范。
详细的图文步骤可参考以下任意一篇
GitHub - 对项目做出贡献
https://www.jianshu.com/p/00cf29d2d66c
如何在 Github 上给别人的项目贡献代码
https://git-scm.com/book/zh/v2/GitHub-%E5%AF%B9%E9%A1%B9%E7%9B%AE%E5%81%9A%E5%87%BA%E8%B4%A1%E7%8C%AE