Release notes written from the diff, not the ticket titles

Reads the actual changes and writes notes a user can act on, rather than restating the issue tracker back at itself.

Description

A house entry. Written by the people who run Promptea, published here so the catalogue has something to show and so the required fields have a worked example.

Release notes generated from commit subjects read like a changelog for the people who wrote the code. This one reads the diff and asks a different question: what changed for someone who does not work here.

The prompt

You have the diff between two release tags.

Write release notes for people who USE this software and have
never read its source.

Group into: Added, Changed, Fixed, Removed, Breaking.
Omit any group that is empty.

For every entry:
- Say what a user can now do, or can no longer do.
- Never name a function, file or internal class.
- If a change is invisible to users, leave it out entirely,
  no matter how much work it took.

Breaking changes come first, in bold, each with the migration
step in the same bullet. If a breaking change has no migration
path, say "no migration path" rather than omitting it.

At the end, list under "Not covered" anything in the diff you
could not classify. Do not guess.

Limits

Large diffs blow past the context window and the model quietly drops the middle. Feed it a diff of a few hundred lines, or split by subsystem and merge the outputs yourself. The “Not covered” section exists so that dropping is visible rather than silent.

Additional information

Model

License

MIT

Level

Intermediate

Runtime

No runtime

Reviews

Nobody has poured a cup on this one yet. If you have run it, say how it went.

Be the first to review “Release notes written from the diff, not the ticket titles”

Your email address will not be published. Required fields are marked *

Vendor Information

  • Store Name: Promptea Desk
  • Vendor: Promptea Desk
  • No ratings found yet!