Willkommen auf myCSharp.de! Anmelden | kostenlos registrieren
 | Suche | FAQ

Hauptmenü
myCSharp.de
» Startseite
» Forum
» Suche
» Regeln
» Wie poste ich richtig?

Mitglieder
» Liste / Suche
» Wer ist online?

Ressourcen
» FAQ
» Artikel
» C#-Snippets
» Jobbörse
» Microsoft Docs

Team
» Kontakt
» Cookies
» Spenden
» Datenschutz
» Impressum

  • »
  • Community
  • |
  • Diskussionsforum
Symbole / Legende für Changelog?
Little Tester
myCSharp.de - Member



Dabei seit:
Beiträge: 120

Themenstarter:

Symbole / Legende für Changelog?

beantworten | zitieren | melden

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.
Dieser Beitrag wurde 5 mal editiert, zum letzten Mal von Little Tester am .
IDE: Visual Studio 2022
Sofern nicht anders genannt basieren meine Projekte auf C# und .net 6
private Nachricht | Beiträge des Benutzers
david.m
myCSharp.de - Member



Dabei seit:
Beiträge: 135

beantworten | zitieren | melden

Schaue Dir mal https://keepachangelog.com/ an.
private Nachricht | Beiträge des Benutzers
Abt
myCSharp.de - Team

Avatar #avatar-4119.png


Dabei seit:
Beiträge: 15.928

beantworten | zitieren | melden

Zitat
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.
private Nachricht | Beiträge des Benutzers
Little Tester
myCSharp.de - Member



Dabei seit:
Beiträge: 120

Themenstarter:

beantworten | zitieren | melden

OK, Danke.
IDE: Visual Studio 2022
Sofern nicht anders genannt basieren meine Projekte auf C# und .net 6
private Nachricht | Beiträge des Benutzers
JimStark
myCSharp.de - Member

Avatar #dOpLzh7hN1az1g0eGRc0.jpg


Dabei seit:
Beiträge: 307

beantworten | zitieren | melden

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
private Nachricht | Beiträge des Benutzers