Skip to content

docs: 新增 CHANGELOG、重寫 README、CLAUDE.md 加入文件更新規則 - #9

Merged
adz624 merged 1 commit into
masterfrom
docs/readme-changelog
Oct 27, 2026
Merged

adz624 merged 1 commit into
masterfrom
docs/readme-changelog

Conversation

@sensui624

Copy link
Copy Markdown
Contributor

內容(僅文件,不跳版號)

  • 新增 CHANGELOG.md(Keep a Changelog 格式,Unreleased 在最上方)。版本與日期對照 rubygems.org 上 xdelivery 實際發佈的 0.1.0 ~ 2.1.0(2.0.2 沒有發佈,已註明),並依 git 紀錄重建內容。
  • 重寫 README.md(英文,與原本一致;原本只有 gem 範本與 TODO):簡介、需求、安裝、設定(timeout / env)、各 API 用法(訂單、銷貨、商品、店鋪、ping、callback 驗證)、history_id、錯誤處理、開發與測試、發版流程。
  • CLAUDE.md 新增規則:每個 PR 都必須同步更新 README.md(行為/用法/需求有變時)與 CHANGELOG.md。

驗證

  • README 範例已在 Ruby 3.4 以 WebMock 實際跑過(送出的 body、response 物件、401/503/timeout 行為、callback 驗證),bundle exec rake t:63 runs, 0 failures。沒有改 lib/。

備註

@adz624
adz624 merged commit 5f0c41c into master Oct 27, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants