编写有效的功能请求:逐步指南

摘要

本文档主题涵盖了如何在 Discourse 中撰写功能请求:分步指南。

第一步:开始之前

您有一个很棒的 Discourse 功能想法?太棒了!以下是如何有效地与团队和社区分享您的想法。在提交功能请求之前,请花点时间搜索现有讨论,看看您的想法是否已被提出或实现。您可以通过以下几种方式进行操作:

查找 Feature 类别

点击页面右上角的 图标,打开 搜索。您可以使用高级过滤器按类别和标签进行筛选。

查看带有 pr-welcome 标签的主题 - PR 是 GitHub 上的拉取请求 - 开发者将新代码引入项目的一种方式。

查看带有 completed 标签的主题

查找 Plugin 类别

如果您的功能建议已列出,您可以支持它,方法是为其投票以使其请求更突出,点赞它,并回复其他想法或用例,以进一步传达其有用性,说明为什么应该添加该功能。

找不到您想法的任何提及?您可以创建一个功能请求。

第二步:基础知识

标题

主题标题很重要,既要信息丰富,又不能太长。一眼就能轻松识别请求的范围。

类别

创建新主题时,请选择 Feature 类别。

标签

标签用于对功能进行分组和分类,因此,为了保持请求的条理清晰,为主题添加适当的标签对跟踪目的非常有帮助。例如,与 chat 插件相关的所有内容都归为一个标签。

Use of tags775×163 11.3 KB

第三步:撰写您的请求

撰写一个好的功能请求很重要,它可以帮助 Discourse 团队快速识别可以改进的领域。

请记住,在创建功能请求时,您是在推销您的想法,并说服人们您的功能想法是有根据的。解释您为什么希望将您的功能添加到社区、您自己以及团队。

在主题正文中,简洁地陈述您请求的功能。要具体和描述性,避免含糊不清或开放式。

提供背景和解释

为您的功能请求提供背景和解释。

清晰描述您请求的功能

包括您当前遇到的问题或用例,以及您的功能将如何解决它

您进行的任何相关背景信息或研究

提供示例和屏幕截图(可选)

如果适用,请提供示例、模型或屏幕截图,以帮助说明您的功能请求,以便其他人可以轻松地可视化您的想法。

与社区互动

创建功能请求后,通过回复问题和反馈与社区成员互动。这将有助于提高您的请求被考虑的机会。

接下来会发生什么

提交功能请求后,它将由社区和 Discourse 团队进行审查。您可以期待:

社区的反馈和讨论

来自 Discourse 员工的回复,表明您的请求是否可行并正在考虑中

在未来的更新中可能实现您的功能请求

希望确保您的功能得以实现?

在某些情况下,功能请求可能不适合核心。您可以 阅读功能决策是如何做出的。如果您无法自己开发该功能,仍然有办法增加其实现的机会。

成为 discourse.org 客户

如果您想通过我们托管的网站来资助开发 - 我们始终在开发时间表中优先考虑客户请求 - 这是加快实现速度的一种方式。企业客户 可以按小时费率向核心团队请求自定义功能(通常以插件的形式)。

赞助“pr-welcome”任务

我们有一个全面的 pr-welcome 主题列表。这些是我们希望完成的任务,但目前没有精力自己处理。赞助某人处理这些任务是参与其中的好方法,并且非常感谢您对 Discourse 的任何贡献。

在 Marketplace 上提供付费工作

如果您需要对您的业务至关重要的插件,请在 Marketplace 上发布付费任务。提供尽可能多的详细信息,包括屏幕截图和预算。您还可以找到提供标准化微服务的自由职业者,例如“一次性安装”或“个性化主题”。

总体

一般注意事项

保持您的请求简洁,并专注于单个功能

避免对实现或技术细节做出假设

表现出愿意根据社区反馈妥协和调整您的想法

不做

每个主题包含多个功能

让其他人质疑您请求的范围

常见问题解答

问:如果我没有时间创建详细的功能请求怎么办?

答:如果您当时无法创建详细的请求,请仔细考虑您想说什么,然后稍后再试。这可以确保您提出最好的论点,从而增加其他人支持您的请求并最终实现它的机会。

问:我应该在哪里发布我的功能请求?

答:使用适当的类别 - 功能请求应放在 Feature 类别中。

问:如果我不确定要为我的请求使用什么标签怎么办?

答:虽然标签与插件和主题组件名称匹配以便于使用,但如果标签为空,团队成员或 Regular 会为您的主题添加适当的标签。

在您的请求中保持尊重和开放的心态。避免使用功能请求来表达沮丧。任何不当的语言或行为都可能导致您的请求被延迟或忽略。

附加资源

Feature - Discourse Meta

Plugin - Discourse Meta

https://meta.stackexchange.com/questions/258136/how-do-i-write-a-good-feature-request

How do we decide what goes into each release of Discourse?

Discourse pricing | Discourse - Civilized Discussion

Marketplace - Discourse Meta

https://meta.discourse.org/c/releases

Upcoming feature to-do list

Topics tagged planned

Extras - Discourse Meta