Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: 🔄 add link to check pixel perfectness in preview comment #2405

Merged

Conversation

lucas-labs
Copy link
Member

@lucas-labs lucas-labs commented Jul 12, 2024

Note

tl;dr

adds a link in the "preview comment" to a tool that lets you see how the icon fits in
a 16x16 grid

Hi!

A while ago, my team and I developed a simple internal tool to check if the icons added by a PR fit ok in a 16x16 pixel grid. A few days ago, we decided to make it open source, adapt it to work with any github repo and hosted it on the web.

Basically, what the web app does is query the GitHub API to get the SVG files added or modified by a PR and display them with an overlaid grid to quickly see if there are any issues. Nothing too fancy, but it ended up being quite useful for us.

This PR simply adds a link referencing the webapp rout to the current PR.

Here's an example:
https://pixp.lucode.ar/material-extensions/vscode-material-icon-theme/pull/2382

image

The source code for the application can be found at lucodear/pixp

I'm opening this PR as a draft to see if you find it interesting and because the web is hosted on our domain. But you can host it in your own domain if you want! We are using cloudflare.

Cheers!

@lucas-labs lucas-labs force-pushed the ci/preview-pixel-perfectness branch from c8fc4c6 to c2b47c5 Compare July 12, 2024 10:34
Copy link
Member

@PKief PKief left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lucas-labs It's a great suggestion! I was already thinking about adding something similar. It's nice that it's already hosted on your domain and people can have a look how their icon looks like in the grid system. And for us it's more easy to do icon reviews 👍

I also like the idea, that we don't move the logic of checking the grid into this repository as well, as it gets much more logic to maintain. For me it sounds very nice, if we continue with the web service which you provided by your domain, if that's ok for you.

@lucas-labs
Copy link
Member Author

@PKief, sure! We can keep it in my domain.

Also, if you have any suggestion/feedback/bug report about the webapp, feel free to ping me.

@lucas-labs lucas-labs marked this pull request as ready for review July 13, 2024 15:45
@PKief PKief merged commit c77f8b3 into material-extensions:main Jul 13, 2024
1 check passed
Copy link

Merge Successful

Thanks for your contribution! 🎉

The changes will be part of the upcoming update on the marketplace.

@lucas-labs lucas-labs deleted the ci/preview-pixel-perfectness branch July 13, 2024 20:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants