|
| 1 | +# 贡献指南 |
| 2 | +很高兴你有意愿参与 TinyEngine 开源项目的贡献,参与贡献的形式有很多种,你可以根据自己的特长和兴趣选择其中的一个或多个: |
| 3 | + |
| 4 | +* 报告新缺陷 |
| 5 | +* 为已有缺陷提供更详细的信息,比如补充截图、提供更详细的复现步骤、提供最小可复现 demo 链接等 |
| 6 | +* 提交 Pull requests 修复文档中的错别字或让文档更清晰和完善 |
| 7 | +* 添加官方小助手微信 opentiny-official,加入技术交流群参与讨论 |
| 8 | + |
| 9 | +当你亲自使用 TinyEngine,并参与多次以上形式的贡献,对 TinyEngine 逐渐熟悉之后,可以尝试做一些更有挑战的事情,比如: |
| 10 | + |
| 11 | +* 修复缺陷,可以先从 Good-first issue 开始 |
| 12 | +* 实现新特性 |
| 13 | +* 完善单元测试 |
| 14 | +* 翻译文档 |
| 15 | +* 参与代码检视 |
| 16 | + |
| 17 | +### 提交 Issue |
| 18 | +如果你在使用 TinyEngine-backend-java 过程中遇到问题,欢迎给我们提交 Issue,提交 Issue 之前,请先仔细阅读相关的官方文档,确认这是一个缺陷还是尚未实现的功能。 |
| 19 | + |
| 20 | +如果是一个缺陷,创建新 Issue 时选择 Bug report 模板,标题遵循缺陷简述 的格式,比如:[TinyEngine-backend-java] 刷新功能无法使用。 |
| 21 | + |
| 22 | +报告缺陷的 Issue 主要需要填写以下信息: |
| 23 | + |
| 24 | +* TinyEngine-backend-java 和 node 的版本号 |
| 25 | +* 缺陷的表现,可截图辅助说明,如果有报错可贴上报错信息 |
| 26 | +* 缺陷的复现步骤,最好能提供一个最小可复现 demo 链接 |
| 27 | + |
| 28 | +如果是一个新特性,则选择 Feature request 模板,标题遵循新特性简述 的格式,比如:[TinyEngine-backend-java] 新增XX主题。 |
| 29 | + |
| 30 | +新特性的 Issue 主要需要填写以下信息: |
| 31 | + |
| 32 | +* 该特性主要解决用户的什么问题 |
| 33 | +* 该特性的 api 是什么样的 |
| 34 | + |
| 35 | +### 提交 PR |
| 36 | +提交 PR 之前,请先确保你提交的内容是符合 TinyEngine Backend Java 整体规划的,一般已经标记为 bug 的 Issue 是鼓励提交 PR 的,如果你不是很确定,可以创建一个 Discussion 进行讨论。 |
| 37 | + |
| 38 | + |
| 39 | +``` |
| 40 | +# username 为用户名,执行前请替换 |
| 41 | +git clone git@github.com:username/tiny-engine-backend-java.git |
| 42 | +cd tiny-engine-backend-java |
| 43 | +git remote add upstream git@github.com:opentiny/tiny-engine-backend-java.git |
| 44 | +
|
| 45 | +``` |
| 46 | + |
| 47 | +提交 PR 的步骤: |
| 48 | + |
| 49 | +* 点击 tiny-engine-backend-java 代码仓库右上角的 Fork 按钮,将上游仓库 Fork 到个人仓库 |
| 50 | +* Clone 个人仓库到本地 |
| 51 | +* 本地编码 |
| 52 | +* 遵循 Commit Message Format 规范进行提交,不符合提交规范的 PR 将不会被合并 |
| 53 | +* 提交到远程仓库:git push origin branchName |
| 54 | +* 打开 TinyEngine-backend-java 代码仓库的 Pull requests 链接,点击 New pull request 按钮提交 PR |
| 55 | +* 项目 Committer 进行 Code Review,并提出意见 |
| 56 | +* PR 作者根据意见调整代码,请注意一个分支发起了 PR 后,后续的 commit 会自动同步,无需重新提交 PR |
| 57 | +* 项目管理员合并 PR |
| 58 | + |
| 59 | +贡献流程结束,感谢你的贡献! |
| 60 | + |
| 61 | +### 加入开源社区 |
| 62 | +如果你对我们的开源项目感兴趣,欢迎通过以下方式加入我们的开源社区。 |
| 63 | + |
| 64 | +* 添加官方小助手微信:opentiny-official,加入我们的技术交流群 |
| 65 | +* 加入邮件列表:opentiny@googlegroups.com |
0 commit comments