4.1 KiB

Raw Permalink Blame History

贡献指南

很高兴你有意愿参与 TinyEngine 开源项目的贡献，参与贡献的形式有很多种，你可以根据自己的特长和兴趣选择其中的一个或多个：

报告新缺陷
为已有缺陷提供更详细的信息，比如补充截图、提供更详细的复现步骤、提供最小可复现 demo 链接等
提交 Pull requests 修复文档中的错别字或让文档更清晰和完善
添加官方小助手微信 opentiny-official，加入技术交流群参与讨论

当你亲自使用 TinyEngine 组件库，并参与多次以上形式的贡献，对 TinyEngine 逐渐熟悉之后，可以尝试做一些更有挑战的事情，比如：

修复缺陷，可以先从 Good-first issue 开始
实现新特性
完善单元测试
翻译文档
参与代码检视

提交 Issue

如果你在使用 TinyEngine 组件过程中遇到问题，欢迎给我们提交 Issue，提交 Issue 之前，请先仔细阅读相关的官方文档，确认这是一个缺陷还是尚未实现的功能。

如果是一个缺陷，创建新 Issue 时选择 Bug report 模板，标题遵循 [toolkitName/pluginName/EngineCore]缺陷简述 的格式，比如：[tiny-engine-toolbar-refresh] 刷新功能无法使用。

报告缺陷的 Issue 主要需要填写以下信息：

tiny-engine 和 node 的版本号
缺陷的表现，可截图辅助说明，如果有报错可贴上报错信息
缺陷的复现步骤，最好能提供一个最小可复现 demo 链接

如果是一个新特性，则选择 Feature request 模板，标题遵循 [toolkitName/pluginName/EngineCore]新特性简述 的格式，比如：[tiny-engine-theme] 新增蓝色主题。

新特性的 Issue 主要需要填写以下信息：

该特性主要解决用户的什么问题
该特性的 api 是什么样的

提交 PR

提交 PR 之前，请先确保你提交的内容是符合 TinyEngine 整体规划的，一般已经标记为 bug 的 Issue 是鼓励提交 PR 的，如果你不是很确定，可以创建一个 Discussion 进行讨论。

本地启动步骤：

点击 TinyEngine 代码仓库右上角的 Fork 按钮，将上游仓库 Fork 到个人仓库
Clone 个人仓库到本地
在 TinyEngine 根目录下运行 pnpm i, 安装依赖
在 TinyEngine 根目录下运行 pnpm dev，启动本地开发

# username 为用户名，执行前请替换
git clone git@github.com:username/tiny-engine.git
cd tiny-engine
git remote add upstream git@github.com:opentiny/tiny-engine.git
pnpm i

# 启动项目
$ pnpm dev

提交 PR 的步骤：

创建新分支 git checkout -b username/feature1，分支名字建议为 username/feat-xxx / username/fix-xxx
本地编码
遵循 Commit Message Format 规范进行提交，不符合提交规范的 PR 将不会被合并
提交到远程仓库：git push origin branchName
(可选)同步上游仓库 develop 分支最新代码：git pull upstream develop
打开 TinyEngine 代码仓库的 Pull requests 链接，点击 New pull request 按钮提交 PR
项目 Committer 进行 Code Review，并提出意见
PR 作者根据意见调整代码，请注意一个分支发起了 PR 后，后续的 commit 会自动同步，无需重新提交 PR
项目管理员合并 PR

贡献流程结束，感谢你的贡献！

加入开源社区

如果你对我们的开源项目感兴趣，欢迎通过以下方式加入我们的开源社区。

添加官方小助手微信：opentiny-official，加入我们的技术交流群
加入邮件列表：opentiny@googlegroups.com

4.1 KiB Raw Permalink Blame History Unescape Escape

贡献指南

提交 Issue

提交 PR

加入开源社区

4.1 KiB

Raw Permalink Blame History