agentleFS
readiumreadium/swift-toolkit/.claude/skills/update-changelog/SKILL.md

update-changelog

Skill574 starsChanged 14 days agoBSD-3-ClauseView on GitHub

Updates or adds entries to CHANGELOG.md based on the changes in the

We split this skill into the rules it gives an agent

7 rules. 0 are common, 4 are distinctive, and 3 are very specific to this project.

  • 0

    Common

    Most of the 35 edited versions we read keep these.

  • 4

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Start each bullet with a past-tense verb or a noun phrase: "Added", "Fixed", "The X now…"

    line 45
  2. Distinctive:

    Do NOT explain implementation details.

    line 48
  3. Distinctive:

    Do NOT document defensive validation (e.g.

    line 49
  4. Distinctive:

    When the API is gated behind an experimental SPI, mention it.

    line 53
  5. Very specific:

    run gh pr view --json number,title,url,author to get the PR for the current branch and its author's login.

    line 60
  6. Very specific:

    Check if the author is a maintainer with gh api repos/readium/swift-toolkit/collaborators --jq '.[].login'.

    line 61
  7. Very specific:

    Only add a contribution credit if the author is not a maintainer, appending (contributed by @login).

    line 62

“Common” is measured: kept by at least 6 in 10 of the 35 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Update CHANGELOG

Overview

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.

CHANGELOG format

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.

Entry style

  • Start each bullet with a past-tense verb or a noun phrase: "Added", "Fixed", "The X now…"
  • Be concise — one to three lines maximum per entry.
  • Mention the public API surface (type name, method name, protocol name) in backticks.
  • Do NOT explain implementation details; focus on what the developer observes or must do.
  • Do NOT document defensive validation (e.g. rejecting out-of-range values). Only document the positive behavior change that developers care about (e.g. "decimal values are now supported").
  • Link to an existing guide when the change is non-trivial to adopt:
    • Migration steps: [the migration guide](docs/Migration%20Guide.md) (or a specific anchor)
    • New feature guide: [the user guide](docs/Guides/...) if a guide exists
  • When the API is gated behind an experimental SPI, mention it.
  • Prefix Fixed entries with the GitHub issue: - [#NNN](URL) Fixed ....

Attributions

For external contributions, we want to attribute the author. Follow these instructions:

  1. run gh pr view --json number,title,url,author to get the PR for the current branch and its author's login.
  2. Check if the author is a maintainer with gh api repos/readium/swift-toolkit/collaborators --jq '.[].login'.
  3. Only add a contribution credit if the author is not a maintainer, appending (contributed by [@login](PR URL)).

Process

  1. Read the diff — run git log --oneline <base>..HEAD and git diff <base>..HEAD to understand what changed. Use develop as the base branch unless told otherwise.
  2. Read the existing [Unreleased] section to avoid duplicating entries that are already there.
  3. Read docs/Migration Guide.md to check whether the changes are already documented there; if so, link to the relevant section in the changelog entry.
  4. Draft entries grouped by section and sub-section. When in doubt whether something is worth documenting:
    • Public API additions/changes/removals → always document
    • Bug fixes visible to the developer → document
    • Internal refactoring with no public API impact → skip
    • Test-only changes → skip
  5. Insert the new entries into CHANGELOG.md under ## [Unreleased], creating sections/sub-sections as needed. Preserve the existing content.
  6. Review the changelog entries to make sure the mentioned APIs are correct.
  7. Show the user the diff of what you added and ask for confirmation before finalizing.

Examples of good entries

### 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.

Download now (ZIP)

  • Other versions36 projects use a version of this.

    Word for word · 0

    None found.

    Edited · 1

    1. readium/kotlin-toolkit★ 39397% same

    Wrote their own version · 35

    1. penpot/penpot★ 62ksame name
    2. alibaba/page-agent★ 29ksame name
    3. joke2k/faker★ 19ksame name
    4. a2ui-project/a2ui★ 17ksame name
    5. google/A2UI★ 17ksame name
    6. quickwit-oss/tantivy★ 16ksame name
    7. btriapitsyn/openchamber★ 12ksame name
    8. openchamber/openchamber★ 12ksame name
    9. mitsuhiko/agent-commands★ 3.2ksame name
    10. mitsuhiko/agent-stuff★ 3.2ksame name

    25 more not listed

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • Used alongsideProjects with it also use clack-cli-patterns, drag-to-reorder and 10 more.

    Other files people use alongside this one.

    Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
    • openchamberSkill

      clack-cli-patterns

      Use when creating or modifying OpenChamber CLI commands, prompts, terminal output, non-TTY behavior, `--quiet`, or `--json` behavior.

      Also in 3 projects that use this

    • openchamberSkill

      drag-to-reorder

      Use when implementing or modifying OpenChamber sortable or drag-to-reorder behavior, especially `@dnd-kit`, touch/mobile interactions, variable-width items, or wrapping layouts.

      Also in 3 projects that use this

    • mitsuhikoSkill

      oebb-scotty

      Austrian rail travel planner (ÖBB Scotty). Use when planning train journeys in Austria, checking departures/arrivals at stations, or looking for service disruptions. Covers ÖBB trains, S-Bahn, regional trains, and connections to neighboring countries.

      Also in 3 projects that use this

    • +9 more from openchamber
  • In this repository4 other files it gives its agents.

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.