csstools / csstools/postcss-plugins
Improve usefulness of changelog by listing changes in dependencies
Nessuno ha ancora preso questa issue.
- Lingua principale
- CSS
- Stelle
- 1.1k
- Fork
- 83
- Merge medio
- 10h 16m
- PR unite (30g)
- 16
Descrizione
Hi! Whenever we update our packages I like to try and provide a compact changelog in the commit description, but I've noticed that this is pretty difficult with the current changelog format for this monorepo.
Often changes are deeply nested, meaning you have to click through the changelogs of multiple packages until you find what actually changed (and then remember which package updates only contained dependency updates so you can skip them).
For an extreme example, consider the recent release of postcss-preset-env version 10.0.0. The changelog in this repo is a huge list of major version bumps of various dependencies, which themselves each have a dependency tree, but I think the actual list of changes is something like this:
- Support for Node v18+
- [css-color-parser] fix
serializeP3whengamutMappingisfalse - [css-tokenizer] Improve performance
- [postcss-nesting] Make edition
2024-02the default - [postcss-content-alt-text] Add specific handling of
content: ">" / "";as this pattern is used in the same way as<img alt="">, i.e. to represent an item that does not need a text alternative.
It would be great if changes to dependencies could be added at the top of the changelog in a format similar to the above, with identical changes being merged ("Support for Node v18+" would be harder to deduplicate, but it's an exceptional case).
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dal formato attuale di plugin-packs/postcss-preset-env/CHANGELOG.md e confrontalo con gli aggiornamenti delle dipendenze descritti nell’issue. Traccia il modo in cui le release dei package registrano attualmente le modifiche alle dipendenze, quindi definisci un modo per rendere visibili e deduplicare tali modifiche all’inizio del changelog; il lavoro sarà completato quando una release come postcss-preset-env 10.0.0 presenterà le modifiche alle dipendenze pertinenti senza richiedere ricerche annidate nei changelog.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- css
- Ambito
- documentation, release
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100