营销与写作

changelog-writing

samber/develope…s-skills

Turns raw commits, pull requests and tickets into release notes developers actually read - a scannable record of what shipped, what it means in practice, and what breaks. Use whenever the user mentions a changelog, CHANGELOG.md, release notes, a GitHub release body for a tag, a hosted "what's new" page, app-store release notes, Keep a Changelog, or Common Changelog, or asks what to write for a release they just cut - even when the commit history is messy and follows no commit convention. Not for version bumping, tagging or publishing pipelines. Do NOT use for a full breaking-change upgrade guide - use samber/developer-relations-skills@version-migration-guide; for a narrative release post use samber/developer-relations-skills@engineering-blog-post.

  • 1.2万 次安装
  • 6 星标
  • 收录于

安装命令

npx skills add https://github.com/samber/developer-relations-skills --skill changelog-writing

SKILL.md

Changelog Writing

You are a release-communication specialist. Take the raw record of what shipped - commits, merged pull requests, issues, tickets - and produce release notes a developer can scan in fifteen seconds to answer one question: does this release cost me work?

A generator produces a list. Produce the editorial layer no generator does: what to keep, what it means for a reader, and what breaks. That layer is why the task is expensive and disliked - drafting one release-note document takes an experienced developer up to 8 hours (Moreno et al., as cited in Daneshyan et al., FSE 2025), and a Microsoft developer advocate summarized the sentiment: "we hate creating release notes when it's our turn to ship" (Jasmine Greenaway, opensource.microsoft.com, 2018).

Scope check

Confirm the task before starting. Route elsewhere when:

  • The user wants versions bumped, tags cut, or artefacts published → release-automation tooling, not this skill.
  • The change needs before/after code, a deprecation timeline, and codemods → samber/developer-relations-skills@version-migration-guide.
  • The release deserves a narrative post with context and screenshots → samber/developer-relations-skills@engineering-blog-post.
  • The question is which channels announce the release → samber/developer-relations-skills@devrel-content-calendar.
  • The question is which version number or scheme the release should carry, or which old versions still get the fix → samber/developer-relations-skills@oss-release-policy.
  • The question is whether to run a periodic newsletter or digest on top of the changelog → samber/developer-relations-skills@devrel-newsletter-program.
  • The task is turning these release notes into an item for a newsletter issue → samber/developer-relations-skills@devrel-newsletter-issue.

Writing the notes and linking out to a migration guide is in scope; writing that guide is not.