UniGetUI icon indicating copy to clipboard operation
UniGetUI copied to clipboard

[ENHANCEMENT] (Enhancing Release Note Generation through Automation)

Open DetectiveCode opened this issue 1 year ago • 3 comments

Please confirm these before moving forward.

  • [X] I have searched for my feature proposal and have not found a work-in-progress/duplicate/resolved/discarded issue.
  • [X] This improvement refers to an existing feature. If you want to suggest a new feature, please use this template.
  • [X] This improvement is not a bug. If you want to report a bug, please use this template.

Describe the improvement

Hello,

We are a group of researchers developing a new automated release note generation tool. Our tool is designed to be highly configurable and widely applicable, working seamlessly with many programming languages and without imposing restrictions or requirements such as commit conventions or workflow adjustments. Our goal is to automatically produce clear, concise, and relevant release notes personalised to your project’s specific needs.

Our approach combines configurability with advanced AI techniques. Specifically, we use supervised learning for categorising and prioritising commits, and large language models for summarising and personalising the content of release notes.

If you’re interested in our work, we would greatly appreciate 5-10 minutes of your time to provide invaluable feedback via our brief questionnaire: 👉🏻 Automatic Release Note Generation Study 👈🏻.

Below, you’ll find an example of a release note generated for this project using an early demo version of our tool.

Thank you for your time and consideration.

Best regards, Release Notes Research Team

unigetui sd auto

Describe how this improvement could help users

The tool is designed to work out of the box with minimal configuration. We are also actively working on features like interactive editing, seamless CI pipeline integration, and more. Our aim is to contribute this tool to the open-source community, saving time for maintainers and providing useful release note for users.

DetectiveCode avatar Aug 25 '24 07:08 DetectiveCode