摘要
本操作指南主题涵盖了如何在 Discourse 中撰写功能请求:分步指南。
步骤 1:开始之前
所以,你有一个很棒的 Discourse 功能想法?太棒了!以下是如何有效地与团队和社区分享你的想法。在提交功能请求之前,请花点时间搜索现有讨论,看看你的想法是否已被建议或实施。你可以通过以下几种方式进行操作:
- 查看 Feature 类别
- 点击页面右上角的
图标以调出 搜索。你可以使用高级过滤器按类别和标签进行筛选。 - 查看带有 pr-welcome 标签的主题 - PR 是 GitHub 上的一个 pull request(拉取请求)- 一种开发人员向项目引入新代码的方式。
- 查看带有 completed 标签的主题
- 查看 Plugin 和 Theme component 类别
如果你的功能建议已列出,你可以通过投票使其请求更突出、点赞以及回复附加的想法或用例来支持它,以进一步传达其有用性,说明为什么应该添加该功能。
找不到任何关于你想法的提及?你可以创建一个功能请求。
步骤 2:基础知识
标题
主题标题需要信息丰富,但同时也不能太长。请求的范围应一目了然。
类别
创建新主题时,请选择 Feature 类别。
标签
标签用于对功能进行分组和分类,因此,为了保持请求的条理清晰,恰当地标记你的主题对于跟踪目的非常有帮助。例如,所有与 chat 插件相关的内容都归于一个标签下。
步骤 3:撰写你的请求
撰写一个好的功能请求很重要,它有助于 Discourse 团队快速识别可能需要改进的领域。
请记住,在创建功能请求时,你正试图推销你的想法,并说服人们你的功能想法是有根据的。向社区、你自己和团队解释你希望添加你的功能的原因。
在主题正文中,简明扼要地说明你请求的功能。要具体和描述性,避免含糊或开放式。
提供背景和解释
为你的功能请求提供背景和解释。
- 你请求的功能的清晰描述
- 包括你当前遇到的问题或用例,以及你的功能将如何解决它
- 任何相关的背景信息或你进行的研究
提供示例和截图(可选)
如果适用,请提供示例、模型或屏幕截图,以帮助说明你的功能请求,以便其他人可以轻松地可视化你的想法。
与社区互动
创建功能请求后,通过回复问题和反馈与成员互动。这将有助于增加你的请求被考虑的机会。
接下来会发生什么
提交功能请求后,它将由社区和 Discourse 团队进行审查。你可能会遇到:
- 社区的反馈和讨论
- Discourse 员工的回复,说明你的请求是否可行并正在考虑中
- 你的功能请求可能在未来的更新中被实施
希望确保你的功能得以实现?
在某些情况下,功能请求可能不适合核心功能。你可以阅读功能决策是如何做出的。如果你无法自己开发该功能,仍有方法可以增加其被实现的机会。
成为 discourse.org 客户
如果你想通过在我们这里托管站点来资助开发——我们总是在开发时间表中优先考虑客户请求——这是更快实现的一种方式。企业客户 可以按小时费率向核心团队请求定制功能(通常以插件形式)。
赞助“pr-welcome”任务
我们有一个全面的 pr-welcome 主题列表。这些是我们很想完成但目前没有精力自己处理的任务。赞助某人来完成这些任务是参与其中的好方法,并且对 Discourse 的任何贡献都非常感激。
在市场上提供有偿工作
如果你需要一个对你的业务至关重要的插件,请在 Marketplace 上发布一个有偿任务。提供尽可能多的细节,包括截图和预算。你还可能会发现提供标准化微服务(如“一次性安装”或“个性化主题”)的自由职业者。
总体
一般注意事项
是
- 保持请求简洁并专注于单个功能
- 避免对实现或技术细节做出假设
- 表现出愿意根据社区反馈进行妥协和调整你的想法
否
- 每个主题包含多个功能
- 让其他人对你的请求范围感到困惑
常见问题解答
问:如果我没有时间创建详细的功能请求怎么办?
答:如果你当时无法创建详细的请求,请仔细考虑你想说什么,稍后再试。这确保你提出了最好的论点,从而增加了其他人支持你的请求并使其被采纳的可能性。
问:我应该在哪里发布我的功能请求?
答:使用适当的类别 - 功能请求应发布在 Feature 类别中。
问:如果我不确定要为我的请求使用哪个标签怎么办?
答:尽管标签与插件和主题组件的名称匹配以方便使用,但如果标签留空,团队成员或常客会为你的主题附加一个适当的标签。
在你的请求中要尊重和思想开放。避免使用功能请求来表达沮丧。任何不当的语言或行为都可能导致你的请求被延迟或忽略。
附加资源
- 类别: Feature, Marketplace, Plugin, Plugin > Extras, Theme, Theme component
- 标签: current-projects, release-notes, pr-welcome, planned
- 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
