¿Hay una convención de nombres para los proyectos de componentes de tema?

Desarrollador
1

¿Existe una convención de nomenclatura para los proyectos de componentes de temas, para que sean fácilmente reconocibles como tales?

Al ver la carpeta en el disco, o el repositorio en GitHub o el proyecto en GitLab u otra forja de código, sería útil poder ver de un vistazo que

  • esto se usará con Discourse
  • es un componente de tema (en contraste con un tema completo de Discourse, un plugin de Discourse o algo diferente)

¿Existe una convención existente sobre cómo comunicar eso en el nombre o en el slug?

1 me gusta
2

No imponemos ninguna convención de nomenclatura… el equipo de Discourse a menudo antepone discourse- a los temas y componentes, pero no es universal.

Más allá del nombre del directorio, esperamos que el readme incluya un poco de contexto de que es para Discourse… de lo contrario, los temas y componentes de temas siempre tienen un archivo about.json con un poco de información, y los complementos contendrán un plugin.rb.

2 Me gusta
3

Utilizo discourse-tc- para indicar un componente de tema porque es una buena práctica y útil para distinguir esos de los temas y complementos.

3 Me gusta
4

Me gusta eso, porque es cortito, pero informativo.

¿Qué convención de nomenclatura (si es que hay alguna) utilizas para los temas y los plugins?

5

Lo mismo aquí

  • discourse-foo para complementos (plugins)
  • discourse-theme-foo para temas completos (full themes)
  • discourse-tc-foo para componentes de tema (theme components)
3 Me gusta