microsoft/fluentui-system-icons

Improve release notes to include visual change indication

Open

#162 opened on Jan 15, 2021

View on GitHubContributor guide
 (0 comments) (2 reactions) (0 assignees)HTML (780 forks)batch import
CI/publishdocumentationenhancementhelp wanted

Repository metrics

Stars
 (10,544 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Investigate the current release notes generation process and identify how to incorporate side by side visual diffs for icon asset changes. Look into tools like ImageMagick or similar for diffing images, and consider adding a script to automate the comparison.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75