agentleFS
hass-energyhass-energy/haeo/.agents/skills/release-notes/SKILL.md

release-notes

Skill77 starsChanged 20 days agoMITView on GitHub

Generate structured release notes from the pull requests between two versions, split into user-facing and developer-facing changes. Use when preparing a GitHub release or when asked for a changelog.

183 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use brainstorm-experiments-existing, brainstorm-ideas-new 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.
  • skytiger6724Skill

    brainstorm-experiments-existing

    Design experiments to test assumptions for an existing product — prototypes, A/B tests, spikes, and other low-effort validation methods. Use when validating assumptions, testing feature ideas cheaply, or planning product experiments.

    Also in 6 projects that use this

  • skytiger6724Skill

    brainstorm-ideas-new

    Brainstorm feature ideas for a new product in initial discovery from PM, Designer, and Engineer perspectives. Use when starting product discovery for a new product, exploring features for a startup idea, or doing initial ideation.

    Also in 6 projects that use this

  • 45ckSkill

    pestle-analysis

    Also in 6 projects that use this

  • About-IntelligenceSkill

    positioning-ideas

    Brainstorm product positioning ideas differentiated from competitors.

    Also in 6 projects that use this

  • About-IntelligenceSkill

    product-name

    Brainstorm 5 unique, memorable product names with rationale aligned to brand values and target audience.

    Also in 6 projects that use this

  • +7 more from skytiger6724

The file

We split this skill into the rules it gives an agent

5 rules. 0 are common, 5 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 168 edited versions we read keep these.

  • 5

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use this structure for the release notes:

    line 19
  2. Distinctive:

    If there are significant developer-facing changes, add a separate Developer highlights subsection within Developer-facing changes

    line 26
  3. Distinctive:

    Use ⚠️ emoji in section header for visibility

    line 31
  4. Distinctive:

    Use GitHub's auto-generated format with PR numbers and author attributions

    line 57
  5. Distinctive:

    Breaking changes go at the top: If there are breaking changes, they must appear immediately after Highlights so users see them first

    line 66

“Common” is measured: kept by at least 6 in 10 of the 168 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

Release notes

Generate release notes for a HAEO release.

Process

  1. Gather context: Identify the version being released and the previous version to compare against
  2. Collect PR information: Pull requests are squash merged with the PR number in the subject, so git log --oneline <previous-tag>..<target> lists them (tags look like v0.4.1); GitHub's auto-generated release notes give the same list with authors
  3. Analyze key PRs: For major features, examine PR descriptions and file changes to understand the scope and user impact
  4. Categorize changes: Group into user-facing vs. developer-facing, features vs. fixes vs. improvements

Output structure

Use this structure for the release notes:

Highlights

  • 2-4 bullet points with emoji icons summarizing the most impactful changes
  • Focus on what users will experience and benefit from
  • Describe outcomes, not implementation details (e.g., "5x faster" not "refactored to declarative architecture")
  • If there are significant developer-facing changes, add a separate Developer highlights subsection within Developer-facing changes

Breaking changes

  • Include only when there are any, immediately after Highlights and before User-facing changes
  • Use ⚠️ emoji in section header for visibility
  • Clearly describe what changed and why it might affect users
  • Provide migration instructions: what users need to do to adapt
  • Be specific about entity names, API changes, or configuration format changes

User-facing changes

  • New features: Visible functionality users can interact with
  • Configuration improvements: UX/workflow improvements
  • Bug fixes: Issues that affected users

Developer-facing changes

  • Developer highlights: Major architectural achievements that developers will appreciate (optional, only for significant changes)
  • Architecture: Internal refactors, performance improvements, structural changes
  • Schema and API changes: Changes to internal systems developers work with
  • Testing and documentation: Improvements to developer experience

Contributors

  • List all contributors with GitHub handles
  • Highlight first-time contributors with 🎉

Full changelog

  • Include the complete list of PRs with links
  • Use GitHub's auto-generated format with PR numbers and author attributions

Guidelines

  • User-facing changes come before developer-facing changes
  • Most important changes appear first within each section
  • Include PR numbers as references (e.g., #186)
  • Be specific about what changed, not just that something changed
  • Highlights must describe user benefits, not implementation: Users care that optimization is faster, not that it uses warm start or declarative patterns
  • Breaking changes go at the top: If there are breaking changes, they must appear immediately after Highlights so users see them first
  • Implementation details belong in Developer-Facing Changes where developers can appreciate them
  • Output as a markdown file ready to paste into GitHub releases

Download now (ZIP)

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.