Existe uma convenção de nomenclatura para projetos de componentes de tema?

Dev
1

Existe uma convenção de nomenclatura para projetos de componente de tema, para que sejam facilmente reconhecíveis como tal?

Ao ver a pasta no disco, ou o repositório no GitHub ou o projeto no GitLab ou outra forja de código, seria útil poder ver de relance que

  • isto deve ser usado com o Discourse
  • é um componente de tema (em contraste com um tema completo do Discourse, um plugin do Discourse, ou algo ainda diferente)

Existe alguma convenção existente sobre como comunicar isso no nome ou no slug?

1 curtida
2

Não impomos nenhuma convenção de nomenclatura… a equipe do Discourse geralmente prefixa temas e componentes com discourse-, mas isso não é universal.

Além do nome do diretório, esperamos que o readme inclua um pouco de contexto de que é para o Discourse… caso contrário, temas e componentes de tema sempre terão um arquivo about.json com algumas informações, e plugins conterão um plugin.rb

2 curtidas
3

Eu uso discourse-tc- para significar um componente de tema porque é uma boa prática e útil para distinguir esses de temas e plugins.

3 curtidas
4

Eu gosto disso, porque é curto, mas informativo.

Qual convenção de nomenclatura (se houver) você usa para temas e plugins?

5

O mesmo aqui

  • discourse-foo para plugins
  • discourse-theme-foo para temas completos
  • discourse-tc-foo para componentes de tema
3 curtidas