Is there a naming convention for theme component projects?

מפתח
1

Is there a naming convention for theme component projects, so that they’re easily recognizable as such?

When seeing the folder on disk, or the repo on GitHub or the project on GitLab or another code forge, it’d be useful to be able to see at one glance that

  • this is to be used with Discourse
  • it’s a theme component (in contrast to a full Discourse theme, a Discourse plugin, or something yet different)

Is there an existing convention on how to communicate that in the name or slug?

לייק 1
2

We don’t enforce any naming conventions… the Discourse team will often prefix themes and components with discourse- but it’s not universal.

Beyond the directory name, hopefully the readme will include a little context that it’s for Discourse… otherwise themes and theme-components always have an about.json file with a little info, and plugins will contain a plugin.rb

2 לייקים
3

I use discourse-tc- to signify a theme component because it’s good practice and handy to distinguish those from themes and plugins.

3 לייקים
4

I like that, because it’s short-ish, yet informative.

What naming convention (if any) do you use for themes and plugins?

5

Same here

  • discourse-foo for plugins
  • discourse-theme-foo for full themes
  • discourse-tc-foo for theme components
3 לייקים