zalando/restful-api-guidelines

Update change log (and document how to do it)

Open

#782 opened on Oct 18, 2023

View on GitHubContributor guide
 (4 comments) (0 reactions) (1 assignee)CSS (356 forks)batch import
help wantedno-zally-change

Repository metrics

Stars
 (1,984 stars)
PR merge metrics
 (Avg merge 14h 36m) (2 merged PRs in 30d)

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

Research direction
Review the keepachangelog format and the repository's git history to retroactively add changelog entries since 2021. Then, document the process in a CONTRIBUTING.md file.
Tech stack
None
Domain
documentationcontent
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85