CONTRIBUTING.md

简体中文 | English

如果你恰好看到了这篇文章，你一定是希望对这个项目贡献自己的一份力量

欢迎任何形式的贡献

"我代码水平不行", "会不会受到鄙视？", "会不会不太好？", 放心，不存在的！

我们欢迎任何形式的贡献，不管是一个错别字的修改，还是一次友好的建议，不管是通过 提交 Issue 还是一个帅气 pull request, 亦或是一次钉钉群的讨论，参与 discussions 的讨论，期待在 贡献者列表 里看见你的头像。

分支管理

目前，我们基于 master 分支开发，有任何修改，请基于 master 拉一个分支，然后通过 PR 的形式，我们集成了钉钉机器人，会第一次时间 review 你的 PR, 给与反馈

提交 Bug

很抱歉又写了一些 bug, 对于没一个 bug report 我们都会非常感激。为了提高沟通效率，请尽量多一些细节描述。

错误示范

推荐步骤

1. 首先选择 [Bug report]

   

2. 按照 Issue 模板 填写相关的信息，是的，这些步骤稍微一些繁琐，但确实必须的，每个用户使用的场景都不同，系统环境，软件版本，又或是需要一些特定的步骤才能复现 bug, 这个时候说清楚，可以节省大家的时间呢～

   

Pull Request

1. fork 项目 并 clone 下来 （或者使用 GitHub 的 Codespace 功能，非常方便）
2. 安装依赖：pnpm bootstrap 或者 pnpm install
3. 提交你的改动，commit 请遵守 AngularJS Git Commit Message Conventions
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@v8 作为包管理

npm i -g pnpm

1. pnpm bootstrap 安装依赖
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 运行单元格测试