ankitects / ankitects/anki

Improve release notes

Aperta
#5,072 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Rust
Stelle
30.5k
Fork
3.2k
Merge medio
2g 8h
PR unite (30g)
60

Descrizione

## 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/

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
github
Ambito
documentation, release
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Tranquilla
Chiarezza
Da chiarire
Idoneità per principianti
38/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.