dev:programming_style
Рекомендации к стилю форматирования
Язык
Все содержимое репозиториев (в том числе README, комментарии в коде и т.д.) - на английском языке.
Текст интерфейса до первого релиза продукта допускается на русском. После релиза - обязательно все основные элементы на английском с русской локализацией.
Описание
Описания репозиториев в git делаются на английском и русском языках, документация на wiki пишется на русском языке, перевод на английский возможен и желателен, но приоритетнее появление документации в целом, чем ее перевод.
Структура репозиториев
- open-web* - набор продуктов, которые предполагают использование на компьютере, а не на мобильном телефоне, соответственно, приоритет нормального вида при верстке - для настольного компьютера или планшета. Но отображение на мобильных должно оставаться функциональным и допустимым, но может быть не очень удобным.
- open-webclient - веб-интерфейс клиента для заказа услуги, для каждого сервиса может быть своим уникальным
- open-init-db - описание структуры БД. Состоит из синхронизируемой части (без изменений для сервиса) и локальной (для каждого сервиса - своя). При этом синхронизируемая и локальная части могут быть под разными лицензиями.
- open-init-services - скрипты для запуска сопутствующих сервисов Open на этапе разворачивания нового сервиса платформы.
dev/programming_style.txt · Последнее изменение: 2022/07/13 15:55 — anton.moiseenko