Laden...

Symbole / Legende für Changelog?

Erstellt von LittleTester vor 2 Jahren Letzter Beitrag vor 2 Jahren 1.006 Views
L
LittleTester Themenstarter:in
158 Beiträge seit 2019
vor 2 Jahren
Symbole / Legende für Changelog?

Ich hatte vor einiger Zeit mal einige Changelogs gesehen, die mit Symbolen, bzw. Zeichen arbeiten, also Beispiel:


[+] = Neue Funktion / neues Feature
[-] = Entfernte Funktion / Entfernte Funktion
[~] = Diverses
usw.

Mir gefällt das System. Ich suche nun die Zeichen für


[] Update Feature / Funktion / Änderung
[] Fix
[] Deprecated 

Ich finde zu dieser Art von Changelog schreiben nichts mehr. Ist das komplett out bzw. außerhalb des Standards und man schreibt es normal, also


[Add]
[Remove]
[Update]
[Fix]
usw.

IDE: Visual Studio 2022
Sofern nicht anders genannt basieren meine Projekte auf C# und .net 6

D
152 Beiträge seit 2013
vor 2 Jahren

Schaue Dir mal https://keepachangelog.com/ an.

16.824 Beiträge seit 2008
vor 2 Jahren

Ist das komplett out bzw. außerhalb des Standards

Es gibt keine Standards, nur "best practises", die sich entwickelt haben.
Symbole gehören definitiv jedoch nicht dazu.

Changelogs werden für Menschen gemacht, nicht für Maschinen - also machs für Menschen einfach.
Und dazu gehört, dass Änderungen gruppiert werden; zB neue Funktionen eben in einer "Added"-Section, Breaking Changes eben in einer extra "Breaking Changes", um diese zu verdeutlichen.
So ist das üblich. So machen das auch die weit verbreiten Tools - nicht mit Symbolen.

L
LittleTester Themenstarter:in
158 Beiträge seit 2019
vor 2 Jahren

OK, Danke.

IDE: Visual Studio 2022
Sofern nicht anders genannt basieren meine Projekte auf C# und .net 6

309 Beiträge seit 2020
vor 2 Jahren

Im Prinzip musst nur du und die Leute die du informieren willst damit klar kommen.
Ich kenne vom sehen auch "+" Added, "*" changed, etc.

Schöner zu lesen ist natürlich ausgeschrieben. Finde folgende Releasenotes immer ganz übersichtlich gemacht:
https://github.com/Hypfer/Valetudo/releases