Keep A Changelog Gruppen und Snippets

Liste an empfohlenen Changelog Gruppen und copy/paste fähige Snippets für Github oder Bitbucket.

TL;DR

Was ist Keep A Changelog

Mit dem Ansatz einer besseren Konvention, liefert keepachangelog.com einen Satz an Changelog Empfehlungen:

  • Changelogs sind für Menschen, nicht für Maschinen.
  • Es sollte einen Eintrag für jede einzelne Version geben.
  • Die gleichen Arten von Änderungen sollten gruppiert werden.
  • Versionen und Abschnitte sollten verknüpfbar sein.
  • Die neueste Version steht an erster Stelle.
  • Das Veröffentlichungsdatum jeder Version wird angezeigt.
  • Erwähne, ob Semantische Versionierung befolgt wird.

Liste an empfohlenen Gruppen

GruppeBeschreibung
AddedNeue Funktionen.
ChangedÄnderungen in der bestehenden Funktionalität.
DeprecatedDemnächst entfernte Funktionen.
RemovedJetzt entfernte Funktionen.
FixedEventuelle Fehlerbehebungen.
SecurityEventuelle Sicherheitslücken.

Github Template

# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [0.1.0] - 2020-01-06
### Added
- Initial release.

[Unreleased]: https://github.com/$example/$repository/compare/0.1.0...HEAD
[0.1.0]: https://github.com/$example/$repository/releases/tag/0.1.0

Bitbucket Template

# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [0.2.0] - 2020-01-06
### Changed
- ...

## [0.1.0] - 2020-01-06
### Added
- Initial release.

[Unreleased]: https://bitbucket.com/$example/$repository/compare/
[0.2.0]: https://bitbucket.com/$example/$repository/compare/0.2.0%0D0.1.0#diff
[0.1.0]: https://bitbucket.com/$example/$repository/commits/tag/0.1.0

Kudos

Schreibe einen Kommentar