Przykład dobrego changeloga
Po wstępie do tematu tworzenia dobrych changelogów przyszedł czas na praktyczny przykład.
Przykład dobrego dziennika zmian
Dla przypomnienia, dobry dziennik powinien być prowadzony w Markdown, mieć przejrzyście wydzielone sekcje, wspierać Semantic Versioning oraz daty w formacie YYYY-MM-DD:
## [Unreleased]
## [0.2.0] - 2016-05-11
### Added
- MSCW requirements document
- I18N: en, pl, de
### Changed
- alerts to Ionic modals
## [0.1.0] - 2016-04-13
### Added
- drug list view
- drug details view
- dose calculator view
- drugs data sets loader
- drug dose calculation algorithms
- UML class diagram
Jest to także dobra okazja by pochwalić się że DDF doczekał się wersji 0.2.0 oraz że zostało wdrożone jedno (choć mało istotnie bo oznaczone jako COULD) wymaganie opisane w dokumencie MoSCoW czyli wsparcie dla I18N.
Zmiany w DDF można także śledzić w jego repozytorium na GitHubie.