One-click install
npx skills add https://github.com/ponylang/llm-skills --skill pony-release-notes
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pony-release-notes
Source: https://github.com/ponylang/llm-skills/tree/main/pony-release-notes
Command: npx skills add https://github.com/ponylang/llm-skills --skill pony-release-notes

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Streamline the creation of user-facing release notes and CHANGELOG entries for Pony projects. This guide ensures end users understand what changed and why it matters, while helping maintainers stay consistent across releases.

Core Features & Use Cases

  • End-user focused notes: Ensure changes are described in user terms, not internal refactoring.
  • Breaking change guidance: Include before/after notes and migration guidance.
  • PR workflow alignment: Align notes with automation labels and split notes by type (Added, Fixed, Changed).

Quick Start

Create a new markdown file in the .release-notes/ directory with a unique, descriptive name and a user-facing title.

Frequently Asked Questions about pony-release-notes

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write release notes for Pony that focus on end users instead of internal refactoring?

Pony release notes should describe user-visible changes in user terms, not internal refactoring. This means summarizing new features, bug fixes, and breaking changes with clear examples so end users understand what changed and why it matters.

How do I document breaking changes in a Pony changelog with migration guidance?

Documenting breaking changes in a Pony changelog requires including before and after code snippets alongside migration guidance. This approach ensures users can smoothly transition between Pony versions by seeing exactly what code needs updating.

What's the best way to categorize changelog entries for Pony version releases?

Categorizing Pony changelog entries is best done by splitting notes into Added, Fixed, and Changed sections. This convention aligns with automation labels and helps maintainers stay consistent across releases while making changes easy to scan.

How do I create a Pony release notes file that aligns with PR workflow automation?

To align Pony release notes with PR workflow automation, create a new markdown file in the .release-notes/ directory using a unique, descriptive name and a user-facing title, then apply automation labels to categorize the entry by type.

Why do Pony release notes need before and after snippets for breaking changes?

Pony release notes need before and after snippets for breaking changes because they provide clear migration guidance. Showing the exact code transformation helps end users quickly understand how to update their projects without guessing.

Can I use standard changelog formatting for Pony release notes and still support end-user documentation?

Yes, standard changelog formatting works for Pony release notes if entries are categorized by type (Added, Fixed, Changed) and written with an end-user focus, ensuring descriptions explain user-visible changes rather than internal refactoring.