|
| 1 | +# Contributing |
| 2 | + |
| 3 | +我们提倡您通过提 Issue 和 Pull Request 方式来促进 APIJSON 的发展。 |
| 4 | + |
| 5 | + |
| 6 | +## Acknowledgements |
| 7 | + |
| 8 | +非常感谢以下几位贡献者对于 APIJSON 的做出的贡献： |
| 9 | + |
| 10 | +- [ruoranw](https://github.com/ruoranw) |
| 11 | +- [zhoulingfengofcd](https://github.com/zhoulingfengofcd) |
| 12 | +- [Zerounary](https://github.com/Zerounary) |
| 13 | +- [vincentCheng](https://github.com/vincentCheng) |
| 14 | +- [justinfengchen](https://github.com/justinfengchen) |
| 15 | +- [linlwqq](https://github.com/linlwqq) |
| 16 | +- [redcatmiss](https://github.com/redcatmiss) |
| 17 | +- [linbren](https://github.com/linbren) |
| 18 | +- [jinzhongjian](https://github.com/jinzhongjian) |
| 19 | +- [CoolGeo2016](https://github.com/CoolGeo2016) |
| 20 | +- [1906522096](https://github.com/1906522096) |
| 21 | + |
| 22 | +其中特别致谢: <br/> |
| 23 | +justinfengchen 提交的 6 个 Commits, 对 APIJSON 做出了 3,130 增加和 0 处删减(截止 2020/11/04 日)； <br/> |
| 24 | +ruoranw 提交的 18 个 Commits, 对 APIJSON 做出了 328 增加和 520 处删减(截止 2020/11/04 日)； <br/> |
| 25 | +Zerounary 提交的 6 个 Commits, 对 APIJSON 做出了 1,104 增加和 1 处删减(截止 2020/11/04 日)。 <br/> |
| 26 | + |
| 27 | +<br/> |
| 28 | +APIJSON 持续招募贡献者，即使是在 Issue 中回答问题，或者做一些简单的 Bug Fix ，也会给 APIJSON 带来很大的帮助。 <br/> |
| 29 | +APIJSON 已开发近 4 年，在此感谢所有开发者对于 APIJSON 的喜欢和支持，希望你能够成为 APIJSON 的核心贡献者， <br/> |
| 30 | +加入 APIJSON ，共同打造一个更棒的自动化 ORM 库！🍾🎉 |
| 31 | + |
| 32 | + |
| 33 | + |
| 34 | +## Issue 提交 |
| 35 | + |
| 36 | +#### 对于贡献者 |
| 37 | + |
| 38 | +在提 Issue 前请确保满足一下条件： |
| 39 | + |
| 40 | +- 必须是一个 Bug 或者功能新增。 |
| 41 | +- 必须是 APIJSON 相关问题。 |
| 42 | +- 已经在 Issue 中搜索过，并且没有找到相似的 Issue 或者解决方案。 |
| 43 | +- 完善下面模板中的信息 |
| 44 | + |
| 45 | +如果已经满足以上条件，我们提供了 Issue 的标准模版，请按照模板填写。 |
| 46 | + |
| 47 | + |
| 48 | + |
| 49 | +## Pull Request |
| 50 | + |
| 51 | +我们除了希望听到您的反馈和建议外，我们也希望您接受代码形式的直接帮助，对我们的 GitHub 发出 Pull Request 请求。 |
| 52 | + |
| 53 | +以下是具体步骤： |
| 54 | + |
| 55 | +#### Fork 仓库 |
| 56 | + |
| 57 | +点击 `Fork` 按钮，将需要参与的项目仓库 Fork 到自己的 Github 中。 |
| 58 | + |
| 59 | +#### Clone 已 Fork 项目 |
| 60 | + |
| 61 | +在自己的 Github 中，找到 Fork 下来的项目，git clone 到本地。 |
| 62 | + |
| 63 | +```bash |
| 64 | +$ git clone git@github.com:<yourname>/APIJSON.git |
| 65 | +``` |
| 66 | + |
| 67 | +#### 添加 APIJSON 仓库 |
| 68 | + |
| 69 | +将 Fork 源仓库连接到本地仓库： |
| 70 | + |
| 71 | +```bash |
| 72 | +$ git remote add <name> <url> |
| 73 | +# 例如： |
| 74 | +$ git remote add APIJSON git@github.com:Tencent/APIJSON.git |
| 75 | +``` |
| 76 | + |
| 77 | +#### 保持与 APIJSON 仓库的同步 |
| 78 | + |
| 79 | +更新上游仓库： |
| 80 | + |
| 81 | +```bash |
| 82 | +$ git pull --rebase <name> <branch> |
| 83 | +# 等同于以下两条命令 |
| 84 | +$ git fetch <name> <branch> |
| 85 | +$ git rebase <name>/<branch> |
| 86 | +``` |
| 87 | + |
| 88 | +#### Commit 信息提交 |
| 89 | + |
| 90 | +Commit 信息请遵循 [Commit 消息约定](./CONTRIBUTING_COMMIT.md)，以便可以自动生成 `CHANGELOG` 。具体格式请参考 Commit 文档规范。 |
0 commit comments