ankitects / ankitects/anki

Improve release notes

Open
#5,072 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
30.5k
Forks
3.2k
Avg merge
2d 8h
Merged PRs (30d)
60

Description

## Problem

Our release notes are mostly generated from PR titles and edited manually before release. This process can be time-consuming as PR titles are not particularly descriptive and user-friendly, so often we need to browse PRs for additional context or rely on LLMs to rewrite the notes for clarity.

## Possible Solution

Enforce adding release notes for every PR before merge. There are tools that help automate this such as [towncrier](https://github.com/twisted/towncrier), which can be used to collect notes from a given directory and rewrite them in a custom/standard format such as [Keep a Changelog](https://github.com/twisted/towncrier/blob/f42c86724a1942768f8f622768b25b157926f73b/docs/markdown.rst).

We can reference the BeeWare project's implementation: https://beeware.org/contributing/guide/how/change-note/

Contributor guide

Open the contributing guide

Research direction

No repository files or tests are named. Start by mapping how pull request titles currently become release notes, then compare the proposed towncrier and BeeWare approaches. Done means a decided workflow that requires release notes before merge and produces clear, consistently formatted release notes.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation, release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.