zalando/restful-api-guidelines

Update change log (and document how to do it)

Open

#782 建立於 2023年10月18日

在 GitHub 查看
 (4 留言) (0 反應) (1 負責人)CSS (1,984 star) (356 fork)batch import
help wantedno-zally-change

描述

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.

貢獻者指南

技術棧
無
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
active
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
knowledge of git historyfamiliarity with Keep a Changelog format
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
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.