При очередном комите в файл записываем кратко смысл коммита, если были значимые изменения.
Изменения записываем в самый верх раздела "Не в релизе".
При публикации все изменения из "Не в релизе" собираются в очередную версию.
Файл с историей релизов заполняется для пользователей библиотеки, поэтому необходимо описывать только те изменения, что важны для пользователей. Описываем изменения так, чтобы пользователям было понятно о чём речь. По возможности прикладываем ссылки на issues.
- Исправлено форматирование документации README
- Исправлено. Библиотека pytest перенесена из основного файла зависимостей в requirements-dev.txt
- Первый релиз