-
Notifications
You must be signed in to change notification settings - Fork 196
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c57a6c4
commit f4d9ab0
Showing
27 changed files
with
162 additions
and
542 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,74 +1,4 @@ | ||
|
|
||
| <img src="https://gw.alipayobjects.com/zos/antfincdn/R8sN%24GNdh6/language.svg" width="18" alt="language" /> 简体中文 | [English](./CONTRIBUTING.en-US.md) | ||
|
|
||
| 如果你恰好看到了这篇文章，你一定是希望对这个项目贡献自己的一份力量 | ||
|
|
||
| ## 欢迎任何形式的贡献 | ||
|
|
||
| "我代码水平不行", "会不会受到鄙视？", "会不会不太好？", 放心，不存在的！ | ||
|
|
||
| 我们欢迎任何形式的贡献，不管是一个**错别字的修改**，还是**一次友好的建议**，不管是通过提交 [Issue](https://github.com/antvis/S2/issues/new/choose), 还是一个帅气 [pull request](https://github.com/antvis/S2/pulls), 亦或是参与 [discussions](https://github.com/antvis/S2/discussions) 的讨论。 | ||
|
|
||
| 这是一个开源项目，我们也有繁忙的业务要做，是用自己的业余时间在维护，为爱发电，精力有限，所以有时候 issue 响应速度不是那么及时。 | ||
|
|
||
| 如果你遇到了问题，或者对 Issues 和 Discussions 列表的问题感兴趣，可以直接认领并尝试修复，帮助 S2 变得更好，期待在 [贡献者列表](https://github.com/antvis/S2/graphs/contributors) 里看见你的头像。 | ||
|
|
||
| ## 分支管理 | ||
|
|
||
| 目前我们主要基于 `master` 和 `next` 分支开发，有任何修改，请基于 `master` 或 `next` 拉一个分支，然后通过 `PR` 的形式提交，我们集成了钉钉机器人，会第一次时间 `review` 你的 `PR`, 给与反馈。 | ||
|
|
||
| - `master`: `1.x` 版本 | ||
| - `next`: `2.x` 版本 | ||
| - `alpha`: `1.x-alpha.x` 版本 | ||
| - `beta`: `1.x-beta.x` 版本 | ||
|
|
||
| ## 🐛 提交 Bug 反馈 | ||
|
|
||
| 很抱歉又写了一些 bug, 但求友好的提交一个有意义的 bug 反馈，谁也不希望反馈的 bug 是这样： | ||
|
|
||
|  | ||
|
|
||
| 没有版本信息，没有复现步骤，没有问题描述，没有代码片段，开局一句话，内容全靠猜。 | ||
|
|
||
| 首先选择 [Bug report](https://github.com/antvis/S2/issues/new?assignees=&labels=&projects=&template=bug-report.md&title=%F0%9F%90%9B) | ||
|
|
||
|  | ||
|
|
||
| 按照 [Issue 模板](https://github.com/antvis/S2/tree/next/.github/ISSUE_TEMPLATE) 填写相关信息。 | ||
| 是的，这些步骤稍微有一些繁琐，但的确是有效且必须的，每个用户使用的场景都不同，系统环境，软件版本，又或是需要一些特定的步骤才能复现 bug, 这个时候说清楚，可以节省大家的时间！ | ||
|
|
||
|  | ||
|
|
||
| ## 🙋♂️ Pull Request | ||
|
|
||
| > 示例 [PR](https://github.com/antvis/S2/pull/1652) (pr 描述参考） | ||
| 1. fork 项目 并 clone 下来 （或者使用 GitHub 的 Codespaces 功能，非常方便）. | ||
| 2. 安装依赖：`pnpm install` 或者 `pnpm bootstrap` 然后本地启动项目。 | ||
| 3. 提交你的改动，commit 请遵守 [AngularJS Git Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.uyo6cb12dt6w). | ||
| 4. 如果你的改动是修复 bug, 还可以在提交信息后面加上 `close #issue 号`, 这样可以在 pr 合并后，可以自动关闭对应的 issue, 比如 `fix: render bug close #123`. | ||
| 5. 确保加上了对应的单元测试和文档 （如果有 `Snapshot` UI 快照 (.snap 文件）更新，可以运行 `pnpm core:test -- -u` 和 `pnpm react:test -- -u` 自动更新，并一起提交上来，请勿手动编辑） | ||
| 6. 所有 Lint 和 Test 检查通过后，并且 review 通过，我们会合并你的 pr. | ||
|
|
||
|  | ||
|
|
||
| ## 开发流程 | ||
|
|
||
| 我们使用 `pnpm` 作为包管理 | ||
|
|
||
| ```bash | ||
| npm i -g pnpm | ||
| ``` | ||
|
|
||
| 推荐本地运行 `pnpm react:playground` 来调试 `@antv/s2` 和 `@antv/s2-react` | ||
|
|
||
| 1. `pnpm install` 安装依赖 | ||
| 2. `pnpm site:bootstrap` 安装网站相关依赖 | ||
| 3. `pnpm site:start` 启动本地的 `S2` 网站 | ||
| 4. `pnpm core:start` 可视化的方式调试核心层 `@antv/s2` （基于 jest-electron) | ||
| 5. `pnpm react:start` 可视化的方式调试组件层 `@antv/s2-react` （基于 jest-electron) | ||
| 6. `pnpm vue:start` 可视化的方式调试组件层 `@antv/s2-vue` （基于 jest-electron) | ||
| 7. `pnpm react:playground` 启动本地的组件层 `@antv/s2-react` demo （基于 vite) | ||
| 8. `pnpm vue:playground` 启动本地的组件层 `@antv/s2-vue` demo （基于 vite) | ||
| 9. `pnpm build` 构建 `@antv/s2` 和 `@antv/s2-react` 和 `@antv/s2-vue` 三个包，分别输出 `umd`, `esm` 和 `lib` 目录 | ||
| 10. `pnpm test` 运行单元格测试 | ||
| 请阅读 [贡献指南](https://s2.antv.antgroup.com/manual/contribution) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,9 +12,6 @@ | |
| </a> | ||
| <a href="https://www.npmjs.com/package/@antv/s2" target="_blank"> | ||
| <img src="https://img.shields.io/npm/v/@antv/s2/latest.svg?logo=npm" alt="latest version"> | ||
| </a> | ||
| <a href="https://www.npmjs.com/package/@antv/s2" target="_blank"> | ||
| <img src="https://img.shields.io/npm/v/@antv/s2/next.svg?logo=npm" alt="next version"> | ||
| </a> | ||
| <a href="https://github.com/antvis/S2/actions/workflows/test.yml" target="_blank"> | ||
| <img src="https://github.com/antvis/S2/actions/workflows/test.yml/badge.svg" alt="ci test status"/> | ||
|
|
@@ -64,7 +61,7 @@ S2 是 AntV 在多维交叉分析表格领域的解决方案，完全基于数 | |
|
|
||
| ## ✨ 特性 | ||
|
|
||
| 1. 多维交叉分析： 告别单一分析维度，全面拥抱任意维度的自由组合分析。 | ||
| 1. 多维交叉分析：告别单一分析维度，全面拥抱任意维度的自由组合分析。 | ||
| 2. 高性能：能支持全量百万数据下 `<8s` 渲染，也能通过局部下钻来实现秒级渲染。 | ||
| 3. 高扩展性：支持任意的自定义扩展（包括但不局限于布局，样式，交互，数据 hook 流等）。 | ||
| 4. 开箱即用：提供不同分析场景下开箱即用的 `React`, `Vue3` 版本表组件及配套分析组件，只需要简单的配置即可轻松实现复杂场景的表渲染。 | ||
|
|
@@ -204,13 +201,12 @@ bootstrap() | |
|
|
||
| ### 📦 版本 | ||
|
|
||
| | Package | Latest | Next | Size | Download | | ||
| | - | - | - | - | - | | ||
| | -------- | ------ | --------- | ---------- | ------ | | ||
| | [@antv/s2](https://github.com/antvis/S2/tree/next/packages/s2-core) |  |  |  |  | | ||
| | [@antv/s2-react](https://github.com/antvis/S2/tree/next/packages/s2-react) |  | |  |  | | ||
| | [@antv/s2-react-components](https://github.com/antvis/S2/tree/next/packages/s2-react-components) |  | |  |  | | ||
| | [@antv/s2-vue](https://github.com/antvis/S2/tree/next/packages/s2-vue) |  |  |  |  | | ||
| | 包名 | 稳定版 | 包大小 | 下载量 | | ||
| | -------- | ------ | --------- | ------ | | ||
| | [@antv/s2](https://github.com/antvis/S2/tree/next/packages/s2-core) |  |  |  | | ||
| | [@antv/s2-react](https://github.com/antvis/S2/tree/next/packages/s2-react) |  |  |  | | ||
| | [@antv/s2-react-components](https://github.com/antvis/S2/tree/next/packages/s2-react-components) |  |  |  | | ||
| | [@antv/s2-vue](https://github.com/antvis/S2/tree/next/packages/s2-vue) |  |  |  | | ||
|
|
||
| ### 🖥️ 兼容环境 | ||
|
|
||
|
|
@@ -222,52 +218,18 @@ bootstrap() | |
|
|
||
| ## 🙋♂️ 问题反馈 | ||
|
|
||
| 有任何问题请严格按照模版 [提交 Issue](https://github.com/antvis/S2/issues/new/choose), 在这之前强烈建议阅读 [《⚠️ 提 Issue 前必读》](https://github.com/antvis/S2/issues/1904) | ||
|
|
||
| ## ⌨️ 本地开发 | ||
|
|
||
| ```bash | ||
| git clone [email protected]:antvis/S2.git | ||
|
|
||
| cd S2 | ||
|
|
||
| # 安装依赖 | ||
| pnpm install # 或者 pnpm bootstrap | ||
|
|
||
| # 打包 | ||
| pnpm build | ||
| 如果你遇到了问题，或者对 [Issues](https://github.com/antvis/S2/issues) 和 [Discussions](https://github.com/antvis/S2/discussions) 列表的问题感兴趣，**可以直接认领并尝试修复**，帮助 S2 变得更好，期待在 [贡献者列表](https://github.com/antvis/S2/graphs/contributors) 里看见你的头像。 | ||
|
|
||
| # 调试 s2-core | ||
| pnpm core:start | ||
| 请严格按照模版 [提交 Issue](https://github.com/antvis/S2/issues/new/choose) 或在 [Discussions](https://github.com/antvis/S2/discussions) 提问，在这之前强烈建议阅读 [《⚠️ 提 Issue 前必读》](https://github.com/antvis/S2/issues/1904) | ||
|
|
||
| # 调试 s2-react | ||
| pnpm react:playground | ||
| ## 🤝 参与贡献 & ⌨️ 本地开发 | ||
|
|
||
| # 调试 s2-vue | ||
| pnpm vue:playground | ||
|
|
||
| # 单元测试 | ||
| pnpm test | ||
|
|
||
| # 代码风格和类型检测 | ||
| pnpm lint | ||
|
|
||
| # 本地启动官网 | ||
| pnpm site:start | ||
| ``` | ||
|
|
||
| ## 🤝 参与贡献 | ||
|
|
||
| 请查看 [贡献指南](https://s2.antv.antgroup.com/manual/contribution) | ||
| S2 非常需要你的共建，请阅读 [贡献指南](https://s2.antv.antgroup.com/manual/contribution) 后提交 PR. | ||
|
|
||
| ## 👁️ 项目洞察 | ||
|
|
||
|  | ||
|
|
||
| ## 📧 反馈问题 | ||
|
|
||
| 有任何问题请严格按照模版 [提交 Issue](https://github.com/antvis/S2/issues/new/choose) 或在 [Discussions](https://github.com/antvis/S2/discussions) 提问。 | ||
|
|
||
| ## 👬 贡献者们 | ||
|
|
||
|  | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.