Skip to content

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

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 實際發佈的 0.1.0 ~ 1.2.1,並依 git 紀錄重建內容。
  • 重寫 README.md(英文,與原本一致;原本只有 gem 範本與 TODO):簡介、需求(依 CI 矩陣)、安裝、DSL 用法(set / excel / presenter / joins / each_with / each_method)、輸出範例、開發與測試、發版流程。
  • CLAUDE.md 新增規則:每個 PR 都必須同步更新 README.md(行為/用法/需求有變時)與 CHANGELOG.md。

驗證

  • README 範例已在 Ruby 3.4 + Rails 8.1 gemfile 實際執行(CSV 輸出、XLSX 工作表名稱、find_in_batches),bundle exec rake test 18 runs, 0 failures。沒有改 lib/。

備註(程式現況,README「Known limitations」已如實記錄,未更動行為)

  • to_xls 目前其實走 XLSX exporter(回傳 xlsx 資料);真正的 .xls 需用 ExportTo::Exporter::Xls。
  • ExportTo::Base#each 會呼叫不存在的 rows! 而 NoMethodError。
  • TESTING.md 的版本清單落後於 CI,這個 PR 未動它。

@adz624
adz624 merged commit c907959 into master Oct 27, 2026
13 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