使用默认主题模板处理功能和缺陷

贡献 网站反馈
1

你好，

既然我在这里了解到分类已经支持主题模板，我建议在此处的 meta.discourse.org 上为 Contribute > Feature（功能贡献）和 Contribute > Bug（Bug 报告）分类使用模板。

我还不完全确定其格式，因此我只是从 Icinga 的一个 GitHub Issue 模板中选取了一个，并针对 Discourse 做了一些修改。

背景

根据我的经验，我们实际上在讨论什么问题，往往不够清晰。为了弄清楚运行环境、可能涉及的工具以及仅存在于用户“大脑”中的想法，来回反复沟通（“打乒乓球”）既耗时又有时令人疲惫。

我想，这样的默认主题模板可以在这里提供帮助，提醒用户哪些细节是重要的，或者如何一般性地格式化他们的“叙述”。

在描述问题时，我通常喜欢使用章节和标题。这样每个人都能跟上思路并提取相关细节。特别是背景信息，以及关于版本和特定浏览器见解的补充信息，会有很大帮助。

模板中有一点比较麻烦——人们有时不太明白 HTML 注释是如何工作的，以及为什么它们在主视图中是隐藏的。尽管我看到许多用户直接采用它并保持原样。

示例

<!--- 在上面的标题中提供问题的总体摘要 -->

<!-- 请确保先阅读 https://meta.discourse.org/t/how-to-request-new-features-for-discourse/32986?source_topic_id=11 -->

## 预期行为
<!--- 如果您是在描述一个 Bug，请告诉我们预期会发生什么 -->
<!--- 如果您是在建议一种更改/改进，请告诉我们它应该如何工作 -->

## 当前行为
<!--- 如果描述 Bug，请告诉我们实际发生的情况，而不是预期行为 -->
<!--- 如果建议更改/改进，请解释与当前行为的区别 -->

## 可能的解决方案
<!--- 非必填，但请提供修复/原因，或者实施：添加或更改的想法 -->

## 复现步骤（针对 Bug）
<!--- 提供实时示例的链接，或一组明确的步骤来 -->
<!--- 复现此 Bug。如果相关，请包含配置、日志等以进行复现 -->
1.
2.
3.
4.

## 背景
<!--- 这个问题如何影响了您？您试图完成什么？ -->
<!--- 提供背景信息有助于我们提出在现实世界中最有用的解决方案 -->

## 您的环境
<!--- 包含关于您遇到问题时的环境的尽可能多的相关细节 -->
* 使用的版本（管理 - 仪表板）：
* 启用的插件（管理 - 插件）：
* 浏览器名称和版本：
* 开发者工具错误：
2 个赞
2

Topic templates aren’t particularly effective in my experience – they are certainly no magic bullet. The type of people you would want to read them, rarely do, and for those that know what they are doing, they get in the way.

I would only do this if there are certain very mandatory things you need in each topic, like serial number or something.

3 个赞
3

Hi,

I get your point, the many who feel disturbed by such a template will just ctrl+a&del the content. I do that sometimes as well, when the structure doesn‘t fit.

I know too little about this community til now. From reading threads I‘d say you do not really need it, as this platform has a totally different conversation “flow” and is more a chat than issue discussions. I love to hear what others think, and won‘t be sad if you do not apply it :slight_smile:

Still, I hope such a template helps others who might have been looking into the same for their setup. It took me quite a while to find the perfect template for github, you likely have only one shot amongst established readers :wink:

Cheers,
Michael