Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[⚠️ 重要] 提 Issue 前必读 !!! #1904

Open
1 of 5 tasks
lijinke666 opened this issue Nov 14, 2022 · 0 comments
Open
1 of 5 tasks

[⚠️ 重要] 提 Issue 前必读 !!! #1904

lijinke666 opened this issue Nov 14, 2022 · 0 comments

Comments

@lijinke666
Copy link
Member

lijinke666 commented Nov 14, 2022

前言

⚠️ 在提出问题前,请确保你已经仔细阅读👓/搜索🔍过 官方文档常见问题 以及 图表示例, 并且已经搜索查阅过相关 Issues 列表. 当你确定自己的问题没有解决方案时,请提交 issue。 ⚠️

⚠️ 在提出问题前,请确保你已经仔细阅读👓/搜索🔍过 官方文档常见问题 以及 图表示例, 并且已经搜索查阅过相关 Issues 列表. 当你确定自己的问题没有解决方案时,请提交 issue。 ⚠️

⚠️ 在提出问题前,请确保你已经仔细阅读👓/搜索🔍过 官方文档常见问题 以及 图表示例, 并且已经搜索查阅过相关 Issues 列表. 当你确定自己的问题没有解决方案时,请提交 issue。 ⚠️

如果是使用问题,不知道怎么用,请移步 S2 讨论区

👍🏻 一些很好的例子 ❌ 一些不好的例子
#852 #1900 #1057 #1868

一个言简意赅的标题

  1. 请填写 标题, 而不是留空

image
image

  1. 请填写 有价值的标题, 而不是 表格报错, 急急急!, xxx 版本报错, 之前是好的, 什么问题?, 什么报错? 什么表格? 一概不知

  2. 请不要将 标题 当做正文写, 标题是标题, 正文是正文

模板说明

👇🏻 下面是 S2 的 Issue 模板,下面会说明这些 "烦人" 的条条框框为什么是必须的?请不要直接删除无视, 或者填写部分, 或者填写一些错误的 markdown 语法。

比如这样

image

又或者这样
image

请点击 Preview 预览一下:

image

🏷 Version

  1. 请填写你实际安装到 node_modules 中的具体版本号,package.json 中写的版本号不代表你实际安装的版本,并请检查是否有 yarn.lock, package-lock.json 之类的版本锁。
  2. 请确保你已经尝试过安装最新版本解决问题,也许你遇到的问题在新版中已经被修复。
  3. 请不要写 latest, 1.x 这种没有意义的版本号,当其他人查看时,完全不具备参考意义。
Package Version
@antv/s2
@antv/s2-react
@antv/s2-vue

Sheet Type

请填写你具体使用的表格,这能帮助我们更快的缩小排查范围,定位问题,请正确使用 markdown

  • PivotSheet
  • TableSheet
  • GridAnalysisSheet
  • StrategySheet
  • EditableSheet

🖋 Description

  1. 请填写你具体的问题描述,请不要惜字如金,尽可能的多提供一些你能想到的有用信息
  2. 请至少懂表格的基本概念,会基本的 JavaScript, 统一用语,不要将 行头 说成 列头, 列头 说成 表头, 统一用语,可以减少我们的沟通成本。

image

⌨️ Code Snapshots

  1. 请粘贴你的核心代码片段,包括但不限于 报错信息, s2Options 配置信息, s2DataConfig 数据源信息
  2. 请不要粘贴你自己的业务代码。
  3. 请不要直接粘贴官网的在线示例链接, 然后告诉我们有问题, 官网不会保存你编辑后的代码, 请粘贴 你的代码片段, 或者使用 codesandbox
  4. 请尽量不要粘贴代码的截图,请使用文本, 请注意使用 markdown code 标签,如果你不会,请自行搜索,去学习。
const a = 1
代码片段应该长这样,而不是一大段没有格式化的代码

🔗 Reproduce Link

  1. 请提供一个精简的可复现链接,它可以让我们更快的帮你复现,定位问题,这很重要,尽量避免 gif, 视频等形式。
  2. 推荐使用 codesandbox, 我们提供了各种版本的模板,方便你反馈问题。查看所有模板
  3. 官网在线示例 支持在线编写代码,你可以将代码转成codesandbox 并将对应的链接发给我们,请不要将官网的代码原封不动的复制给我们,请不要 这么麻烦, 还要复现链接? 赶紧给我修啊, 很急!, 请不要 打了一个压缩包给你, 代码都在这, 给我修吧,更不要 复现步骤,联系 [email protected]

image
6. 请不要 开局一张图,内容全靠猜, 我们不是侦探

🤔 Steps to Reproduce

  1. 请不要惜字如金,粘贴一个张图或者一句话就草草了事,我们需要你详细的复现步骤,这个问题需要怎么样的操作步骤才能复现。
  2. 不同的问题有不同的复现步骤,只有你最清楚怎么复现这个问题,比如问题需要 滚动表格到指定位置才能复现, 但是通篇都没有提到, 而你就贴一张图, 什么信息都不给:所以请 1. 拖动表格滚动条,滚动到 xx 位置 2. 停留 300ms, 3. tooltip 消失

😊 Expected Behavior

说明这个问题的预期行为,只有你才最了解自己的代码,所以请不要让我们猜,请说明预期,不如 数据不对,正确应该是:xx, 布局错误:正确应该是 A 节点在 B 位置, 如果可以的话, 使用截图工具标注一下, 让问题更醒目。

😅 Current Behavior

说明这个问题当前行为

💻 System information

你用的 windows 还是 macOS, 版本是多少,用的什么浏览器,版本是多少?花上一点点时间填写,可以节省后续的很多重复问答。

Environment Info
System macOS 12.6
Browser Chrome 107.0.5304.110

最后

提问也是有成本的,请做到互相尊重,我们在收到 issue 后,会认真阅读并尽快排查问题,如果你的 issue 迟迟没有被处理,请先检查一下自己提交的 issue 是否满足条件。

这是一个开源项目, 我们也有繁忙的业务要做, 是用自己的业余时间在维护, 为爱发电, 精力有限, 所以有时候 issue 响应速度不是那么及时, 如果你感兴趣, 也可以直接参与进来贡献, 帮助我们修复问题,而不是一味的埋怨和催促, 我们不是甲方乙方的关系.

还请互相理解, 强烈建议花一点你的宝贵时间阅读:

@lijinke666 lijinke666 changed the title [⚠️ 重要] 提 Issue 前必读 !!! (⚠️ 重要) 提 Issue 前必读 !!! Nov 14, 2022
@lijinke666 lijinke666 pinned this issue Nov 14, 2022
@lijinke666 lijinke666 changed the title (⚠️ 重要) 提 Issue 前必读 !!! [⚠️ 重要] 提 Issue 前必读 !!! Nov 14, 2022
@github-actions github-actions bot added the 💤 inactive 不活跃的 Issue 或 PR, 30天没有回复 label Dec 31, 2022
This was referenced Sep 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant