主题组件项目有命名约定吗?

关于主题组件项目是否有命名约定,以便它们易于识别?

当在磁盘上看到文件夹,或在 GitHub 上看到仓库,或在 GitLab 或其他代码托管平台看到项目时,能够一眼看出:

  • 这是要与 Discourse 一起使用的
  • 这是一个主题组件(与完整的 Discourse 主题、Discourse 插件或其它不同的东西相区别)

在名称或 slug 中传达这一点是否存在现有的约定?

1 个赞

我们不强制执行任何命名约定……Discourse 团队通常会用 discourse- 作为主题和组件的前缀,但这并非通用做法。

除了目录名称之外,希望自述文件能包含一些上下文信息,说明它是用于 Discourse 的……否则主题和主题组件始终会有一个包含一些信息的 about.json 文件,而插件会包含一个 plugin.rb 文件。

2 个赞

我使用 discourse-tc- 来表示主题组件,因为这是很好的做法,并且方便将其与主题和插件区分开来。

3 个赞

我喜欢这个,因为它简短但信息丰富。

你们对主题和插件使用什么命名约定(如果有的话)?

我也是

  • 插件使用 discourse-foo
  • 完整主题使用 discourse-theme-foo
  • 主题组件使用 discourse-tc-foo
3 个赞