История изменений

Опциональная практика

Если изменения в коде ведутся без связки с задачами в Jira/Trelle/etc, где есть возможность собирать задачи в release, то рекомендуется использовать файл Changelog для фиксации изменений. Для публичных репозиторием changelog обязателен.

В корне каждого репозитория должен лежать файл changelog.md с историей изменения проекта. В целом следуем рекомендациям, представленным в этой статей.

Язык - русский.

Дополнительные аспекты:

• Для изменений, для которых в Jira заведен тикет, нужно добавлять ссылку на тикет. Например:

### Added
- [SAC-295](https://siisltd.atlassian.net/browse/SAC-295) Изменение типа оплаты до первой выгрузки

• Ведется секция Deploy, в которой должно указываться:
  • какие компоненты нужно обновить
  • какие изменения нужно вносить в файлы конфигураций
  • какие миграции надо выполнить
  • с суффиксом ВАЖНО указывается информация, которая критически важна для обновления (например, что нарушена совместимость, что-то может не работать)