GitHub’s preview cards aren’t that useful


Featured images are a common piece of metadata you can add to a website or blog post. It’s a way for people to preview your content with a still image when linked to on social media, and can be more enticing and useful than just a static URL. Schema metadata, Dublin Core RDF, OpenGraph, and Twitter Cards all have metadata to define these images.

It’s not always as simple as defining an image and calling it a day, though. Care has to be taken that these images make sense in a wide array of contexts. Some viewports show the image in its entirety, but might render it small enough that tiny details are lost. Most often these images are cropped, so just like overscan on an old TV, you need to make sure the image makes sense when shown as a square, or if the corners are rounded off.

GitHub recently implemented a feature that autogenerates preview images with useful information about repositories and pull requests, such as the number of files, commits, changes, and the developer. Here’s an example:

Unfortunately, this is all I ever see on my clients:

These images aren’t essential; one can click through to see the repository. But you may as well optimise them if you’re going to go to the trouble of auto-generating them in the first place. Placing important details in the centre would make them useful for more people, with ancillary items like avatars and language breakdowns flanking either side.

I have other reservations about GitHub which are beyond the scope of this post, but I thought this was a useful example of a wider issue.

Author bio and support


Ruben Schade is a technical writer and infrastructure architect in Sydney, Australia who refers to himself in the third person. Hi!

The site is powered by Hugo, FreeBSD, and OpenZFS on OrionVM, everyone’s favourite bespoke cloud infrastructure provider.

If you found this post helpful or entertaining, you can shout me a coffee or send a comment. Thanks ☺️.