microsoft/fluentui-system-icons

Improve release notes to include visual change indication

Open

#162 ouverte le 15 janv. 2021

Voir sur GitHub
 (0 commentaires) (2 réactions) (0 assignés)HTML (10 544 stars) (780 forks)batch import
CI/publishdocumentationenhancementhelp wanted

Description

When the icon assets are altered it would be nice to have a visual, side-by-side, indication of before/after. One can look at the rich diffs of the PRs but adding a file to the release notes would be helpful for people needing to easily scan for the difference.

Guide contributeur

Stack technique
Aucun
Domaine
documentation
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Familiarity with icon assetsKnowledge of release process
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60
Direction de recherche
First, understand the current release notes generation process by examining repository workflows and scripts (e.g., .github/release.yml or scripts in the repository). Then, design a method to generate a visual before/after comparison of icon changes, possibly using image comparison libraries or tools. Finally, implement a script that runs during release to produce the comparison file and integrate it into the release notes.