القائمة
Updates or adds entries to CHANGELOG.md based on the changes in the current branch. Use this skill whenever the user asks to update the changelog, add a changelog entry or document changes.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
| name | update-changelog |
| description | Updates or adds entries to CHANGELOG.md based on the changes in the current branch. Use this skill whenever the user asks to update the changelog, add a changelog entry or document changes. |
You are writing changelog entries for the Readium Swift Toolkit. The audience is app developers who integrate this toolkit – not contributors. Entries tell them what changed and, when necessary, how to adapt their code.
The file is at CHANGELOG.md. New entries go under ## [Unreleased].
Structure within [Unreleased]:
## [Unreleased]
### Added
#### Playground
#### Shared
#### Navigator
### Deprecated
...
### Changed
#### Playground
...
### Fixed
...
Omit the sub-section heading for cross-cutting changes.
[the migration guide](docs/Migration%20Guide.md) (or a specific anchor)[the user guide](docs/Guides/...) if a guide exists- [#NNN](URL) Fixed ....For external contributions, we want to attribute the author. Follow these instructions:
gh pr view --json number,title,url,author to get the PR for the current branch and its author's login.gh api repos/readium/swift-toolkit/collaborators --jq '.[].login'.(contributed by [@login](PR URL)).git log --oneline <base>..HEAD and git diff <base>..HEAD to understand what changed. Use develop as the base branch unless told otherwise.[Unreleased] section to avoid duplicating entries that are already there.docs/Migration Guide.md to check whether the changes are already documented there; if so, link to the relevant section in the changelog entry.CHANGELOG.md under ## [Unreleased], creating sections/sub-sections as needed. Preserve the existing content.### Added
#### Playground
* New `Playground` iOS app – a minimal SwiftUI sample demonstrating how to use the Readium Swift Toolkit and to test its API.
* `Recipes/` contains self-contained and explained code you can reuse in your own application.
* `App/` folder contains the scaffolding (file management, navigation, error handling) needed to run the Playground.
#### Shared
* Added support for SVG covers in `ResourceCoverService`. SVG images can now be used as publication covers and are rendered to bitmaps (contributed by [@grighakobian](https://github.com/readium/swift-toolkit/pull/751)).
* `Publication` has a new experimental `coverData(accepting:)` API that returns the raw bytes and media type of the cover, useful for storing the original cover without re-encoding.
### Fixed
#### Navigator
* [#721](https://github.com/readium/swift-toolkit/issues/721) Fixed position of EPUB decorations when using the paragraph indent preference.
Write a blog post and Discord announcement for a new Readium Swift Toolkit release. Use this skill whenever the user wants to announce a new version, write a blog post, or draft a Discord post.
Write Swift unit tests using Swift Testing (the modern Apple testing framework, not XCTest). Use this skill whenever the user asks to write tests, add test cases, create a test suite, or test a Swift type or function. Also triggers when the user asks to convert XCTest tests to Swift Testing, or when adding new tests to an existing XCTest-based file (always convert first). Invoke proactively when the user has just written a new Swift type or function and hasn't tested it yet.
Use this skill to write user guides about features in the Readium Swift Toolkit. Invoke whenever the user wants to document a feature, API, or workflow — whether they say "write docs for X", "document this feature", "create a guide for Y", "write a user guide", or "explain how to use Z".