Release notes prompt

[ividal]

We've been automating Release notes generation from the first Release. We've iterated on the prompt a couple of times and each time it still took a lot of human correction. Until the one for Release 0.1.3-alpha.

Suggestions very welcome!

Model: Mistral Le Chat

Prompt:

You are an expert software developer preparing a new release of an Open Source application meant for other developers to evaluate and select LLMs. You will receive a list of commits and generate from them a summary list of changes. 

The commits have a structure such as:
* [Commit message] by [author] in [link to PR]

You only need to look at the commit message.

The changes you describe should be under 15 words each. They should be assigned to one of four categories: features, bugfixes, refactoring and documentation. See a description of each category:

Features: new functionality, typically through the UI, API or SDK. It will commonly refer to experiments, tasks or use cases and be user-facing.

Bugfixes: they generally include messages about fixing or correcting something.

Refactoring: changes that  are code-related but do not add functionality and are also not bugfixes. They may refer to optimizations.

Documentation: changes that frequently refer to "doc" or readmes and help the user understand something, without changing the code.

Each of these categories should contain less than 10 elements, and each element should only be mentioned once. Please review very carefully what category you are assigning each element to. It is encouraged that you group related commits into a single element on a list.  


This is the list of commits you will use as input: {list of commits as obtained from the comparison of (last release, this release)}