zalando/restful-api-guidelines

Update change log (and document how to do it)

Open

#782 geöffnet am 18. Okt. 2023

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (1 zugewiesene Person)CSS (356 Forks)batch import
help wantedno-zally-change

Repository-Metriken

Stars
 (1.984 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 3T 12h) (2 gemergte PRs in 30 T)

Beschreibung

The change log hasn't been updated since 2021, but we can do it retroactively to make it easier to understand the recent changes. See https://keepachangelog.com/en/1.1.0/

This can then be used as the base for our next (internal) API newsletter.

Contributor Guide

Research-Richtung
Überprüfen Sie die Keep a Changelog Spezifikation unter https://keepachangelog.com/en/1.1.0/. Analysieren Sie das Git Log des Repositorys, um wichtige Änderungen seit dem letzten Changelog Update im Jahr 2021 zu extrahieren. Aktualisieren Sie dann CHANGELOG.md gemäß dem empfohlenen Format. Die Maintainer können in den Kommentaren zusätzliche Anleitungen bereitstellen.
Tech Stack
Keine
Domain
documentationcontent
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85