GitHub Discussions¶
适合长篇、可搜索的交流,将来的用户能通过 Google 找到——例如答案可复用的问题、提交 PR 之前的设计提案,以及基于 TensorMesh 完成工作的总结文章。
当您希望交流内容能长期保留时,请使用 Discussions。若需要快速的来回交流,请改用 Discord;对于已确认的缺陷或具体的功能请求,请提交 GitHub Issues。
前往 Discussions¶
发帖或评论需要 GitHub 账号。阅读则对所有人开放。
类别指南¶
共有五个类别,每个类别针对一种不同类型的帖子。请选择与您所写内容相符的类别;如果拿不准,General 总是稳妥之选——必要时维护者会将其移动到合适的类别。
类别 |
形式 |
适合发布的内容 |
|---|---|---|
Announcements |
公告(只读) |
发布说明、API 弃用、计划中的破坏性变更、社区活动。由维护者发布。如果您在生产环境或论文中依赖本库,请订阅此类别。 |
Q&A |
问答(带有 Mark as answer 功能) |
使用问题、安装/环境问题、"我该如何用 TensorMesh 做 X" 之类的问题。发帖人——或某位维护者——会将某条回复标记为采纳的答案,从而让该帖对下一个遇到同样问题的人有所帮助。 |
Ideas & RFCs |
开放讨论 |
关于新功能、API 设计、破坏性变更的提案——在您编写 PR 之前。先在这里抛出想法,通常能省去后续一轮"其实我们希望它换一种形式"的评审。请在后续评论中关联最终的 issue / PR。 |
Show & Tell |
开放讨论 |
使用了 TensorMesh 的论文、仿真动画、博客文章、教学材料、与其他有限元工具栈的对比图表。在这里欢迎自我推广——这正是该类别的意义所在。 |
General |
开放讨论 |
任何与有限元方法、PyTorch 或偏微分方程相关,但不适合归入上述类别的内容。包罗万象的类别。 |
如何写好一篇问答帖¶
Discord 求助频道指南中的同一份清单在这里同样适用,而且在这里更为重要,因为将来的读者会通过搜索找到您的帖子——他们能依据的只有您所写的内容。完整清单见 如何提出一个好的求助问题。简要版本如下:
您运行了什么——一段最小的、可直接复制粘贴的代码片段。
您看到了什么——完整的回溯信息,放在代码块中。
您期望什么——形状、数值或行为。
版本信息——
python -c "import torch, torch_sla, tensormesh; print(torch.__version__, torch_sla.__version__, tensormesh.__version__)"的输出,以及(如相关)操作系统和 CUDA 版本。
一个有用的习惯:当问题解决后,编辑原帖,在开头添加一行"Resolution:"(解决方案)摘要,这样将来的读者就无需翻阅来回的讨论。然后再标记出给出答案的那条回复。
Discord、Discussions 与 Issues 的对比¶
这三种渠道解决的是不同的问题。一旦您明确了自己要做什么,选择通常就很简单:
您想要…… |
使用 |
|---|---|
实时交流,在几分钟内摆脱困境 |
Discord( |
提出一个其答案将来应可被搜索到的问题 |
Discussions → Q&A |
提出一项新功能或 API 变更供讨论 |
Discussions → Ideas & RFCs |
分享一篇论文、演示或总结文章 |
Discussions → Show & Tell |
报告一个带有复现步骤的、已确认的缺陷 |
|
请求一项具体、可落地的功能 |
GitHub Issues(对于较大的功能,先在 Discussions 中做一次快速确认之后) |
发布公告 / 接收发布通知 |
Discussions → Announcements(关注此类别) |
拿不准时:发到 Discussions,并从 Discord 附上链接。看似一次性的聊天往往后来对他人很有用,而把一次 Discord 交流整理成一个 Discussion 帖子,是一件对维护者很友好的事。
标签¶
维护者可能会为问答类讨论打上诸如 installation、cuda、meshing、assembly、solver、autograd 或 docs 之类的标签,以便进行搜索过滤。您无需为自己的帖子打标签——只要选对类别,标签自然会随之而来。
礼仪规范¶
适用于 Discord 的同一套规范在这里同样适用:保持友善、让分歧停留在技术层面、禁止垃圾信息。此外还有几条专门针对 Discussions 的礼节:
发帖前先搜索。 许多问题已经有人问过。GitHub 在 Discussions 内的页面搜索还不错;在 Google 上快速搜索
site:github.com/camlab-ethz/TensorMesh/discussions <your terms>则效果更佳。每个帖子只讨论一个主题。 如果您发现自己在同一篇帖子里描述了两个不相关的问题,请将其拆开。问答区的串联回复只有在问题是单一问题时才能良好运作。
不要重复开帖。 如果您的问题与某个已有帖子相符,请在那里评论,而不要新开一个帖子——即便那个已有帖子已经关闭。维护者会重新打开它或将您引导到合适的地方。