Существует ли соглашение об именовании для проектов компонентов тем?

Разработка
1

Существует ли соглашение об именовании для проектов компонентов тем, чтобы их было легко узнавать как таковые?

При просмотре папки на диске, репозитория на GitHub, проекта на GitLab или другой платформы для хостинга кода было бы полезно сразу видеть, что:

  • этот проект предназначен для использования вместе с Discourse;
  • это компонент темы (в отличие от полной темы Discourse, плагина Discourse или чего-то ещё иного).

Существует ли уже какое-либо соглашение о том, как это можно отразить в названии или слаг-идентификаторе?

1 лайк
2

Мы не требуем соблюдения каких-либо соглашений об именовании… Команда Discourse часто добавляет префикс discourse- к темам и компонентам, но это не является универсальным правилом.

Помимо названия директории, мы надеемся, что в файле readme будет указано, что это для Discourse… В противном случае темы и компоненты тем всегда содержат файл about.json с небольшой информацией, а плагины — файл plugin.rb.

2 лайка
3

Я использую префикс discourse-tc- для обозначения компонента темы, так как это хорошая практика и удобно для их отличия от тем и плагинов.

3 лайка
4

Мне это нравится, потому что это кратко, но информативно.

Какое соглашение об именовании (если оно есть) вы используете для тем и плагинов?

5

У меня то же самое

  • discourse-foo для плагинов
  • discourse-theme-foo для полных тем
  • discourse-tc-foo для компонентов тем
3 лайка