Skip to content

Commit

Permalink
feat(docs): add benchmark in CONTRIBUTING docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Timeless0911 committed Nov 20, 2023
1 parent 4dffb01 commit 50b24cd
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,16 @@ pnpm run lint

---

## Benchmarking

You can input `!bench-framework` or `!bench-module` in the comment area of ​​the PR to do benchmarking on `@modern-js/app-tools` and `@modern-js/module-tools` respectively (you need to have Collaborator and above permissions).

You can focus on metrics related to build time and bundle size based on the comparison table output by comments to assist you in making relevant performance judgments and decisions.

Dependencies installation-related metrics base on publishing process, so the data is relatively lagging and is for reference only.

---

## Documentation

Currently Modern.js provides documentation in English and Chinese. If you can use Chinese, please update both documents at the same time. Otherwise, just update the English documentation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,16 @@ pnpm run lint

---

## Benchmarking

你可以在 PR 的评论区中输入 `!bench-framework``!bench-module` 分别对 `@modern-js/app-tools``@modern-js/module-tools` 做性能测试(这需要你具有 Collaborator 及以上的权限)。

你可以根据评论输出的对比表格,重点关注构建时间和产物体积相关的指标,辅助进行相关性能判断与决策。

依赖安装相关指标由于需要前置的发包流程,因此数据相对有滞后性,仅供参考。

---

## 文档

目前 Modern.js 提供英文和中文文档。如果你熟悉中文,请同时更新中英文文档。否则,只需更新英文文档即可。
Expand Down

0 comments on commit 50b24cd

Please sign in to comment.