microsoft/fluentui-system-icons

Improve release notes to include visual change indication

Open

#162 opened on Jan 15, 2021

View on 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.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with icon assetsKnowledge of release process
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
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.