microsoft/fluentui-system-icons

Improve release notes to include visual change indication

Open

#162 aberto em 15 de jan. de 2021

Ver no GitHub
 (0 comments) (2 reactions) (0 assignees)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.

Guia do colaborador

Pilha de tecnologia
None
Domain
documentation
Tipo Issue
feature
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
Familiarity with icon assetsKnowledge of release process
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60
Direção de pesquisa
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.