zalando/restful-api-guidelines

Update change log (and document how to do it)

Open

#782 opened on Oct 18, 2023

View on GitHub
 (4 comments) (0 reactions) (1 assignee)CSS (1,984 stars) (356 forks)batch import
help wantedno-zally-change

Description

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

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
knowledge of git historyfamiliarity with Keep a Changelog format
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Review the Keep a Changelog specification at https://keepachangelog.com/en/1.1.0/. Analyze the git log of the repository to extract significant changes since the last changelog update in 2021. Then, update CHANGELOG.md following the recommended format. The maintainers may provide additional guidance in the comments.