[ADR] Дополнения к политике по Breaking Change: словари.

[ickisIckis]

Мотив
В первоначальной разработке Prizm, мультиязычность не рассматривалась как приоритетная задача, ввиду ограниченных сроков для выпуска первой версии продукта и отсутствия явных требований к поддержке нескольких языков. Это привело к тому, что в компонентах были использованы статические тексты. С течением времени, появилась необходимость в интеграции мультиязычности, что инициировало создание интерфейсов для управления текстовыми моделями, как отдельных компонентов, так и общих текстовых элементов. С помощью этих интерфейсов разработчики получили возможность контролировать полноту перевода при добавлении поддержки новых языков.

Необходимость в замене первоначальных статических текстов и непрерывное развитие проекта стимулируют регулярное обновление текстовых интерфейсов. Однако данное действие вступает в противоречие с принципами поддержания обратной совместимости при использовании своих словарей разработчиками, что является одним из ключевых аспектов стабильности и надежности программного обеспечения.

Предложение решения
Для текстовых интерфейсов предлагается внести следующие изменения в политику управления изменениями (breaking change policy):

Разрешить расширение текстовых интерфейсов при повышении версии как нового функционала.
Запретить изменения существующих текстов и ключей для них в словарях.
Не добавлять новые опциональные переводы.
Эти изменения позволят быстрее поставлять новый функционал. При обновлении версии, если разработчик использует нестандартные переводы, он получит сообщение об ошибке о пропущенном тексте и сможет оперативно исправить её.

Долгосрочные цели
К моменту выпуска версии 5.0, ключевой задачей для команды Prizm станет нативная поддержка двух основных языков - русского и английского. Это включает в себя интеграцию переводов непосредственно в код продукта и устранение любых статических текстов, что значительно упростит процесс обновления и расширения базовых языковых интерфейсов в будущем.

Чтобы обеспечить удобство и гибкость использования Prizm в многоязычных средах, разработчикам будет предоставлена возможность интеграции собственных словарей для тех языков, которые не поддерживаются нативно. Это позволит пользователям Prizm локализовать приложения с учетом специфических языковых требований и предпочтений их целевой аудитории.

Особенно важно для разработчиков, которые ранее внедряли собственные переводы на английский язык, рассмотреть возможность перехода на официально поддерживаемые переводы Prizm. Это обеспечит большую согласованность и качество локализации. В случаях, когда требуется дополнительная кастомизация, разработчики могут расширять официальные словари, добавляя специфические переводы, необходимые для их проектов.

Эти шаги направлены на то, чтобы Prizm предоставлял более универсальные и удобные инструменты для работы с локализацией, облегчая разработчикам процесс обновления и поддержки мультиязычных приложений.

Последствия

• Ускорение доставки функционала переводов.

• Оповещение разработчиков об ошибках на этапе сборки проекта, снижение вероятности багов.

• Гарантия, что в проект не попадут неожиданные тексты на неподдерживаемых языках.

• Появятся breaking change, что потребует изменений на стороне проектов только если они используют свои словари, не расширяя наши

Принято 22.02.2024