The-turing-way: Design an "I want to contribute!" badge for the readme

Created on 6 Feb 2020  路  7Comments  路  Source: alan-turing-institute/the-turing-way

Summary

I found this "I want to contribute!" button on the BinderHub readme. It links to the contributing guidelines and I think it's a cool way of directing people to the relevant information to getting started.

I want to contribute button in BinderHub readme

What needs to be done?

  • [ ] Design a _Turing Way_ version

Who can help?

  • Anyone

Updates

community

Most helpful comment

@KirstieJane thanks! That helped a lot.

All 7 comments

A quick creation 馃槃

Raw:

[![](https://img.shields.io/static/v1?label=TuringWay&message=I%20want%20to%20contribute!&color=green)](https://github.com/alan-turing-institute/the-turing-way/blob/master/CONTRIBUTING.md)

Rendered:

Things to decide on:

  • Label (currently it says TuringWay)
  • Color (currently green; I suggest blueviolet so it matches with the newsletter badge, which also is Turing Way specific out of the badges and provides some consistency)
  • Link (currently https://github.com/alan-turing-institute/the-turing-way/blob/master/CONTRIBUTING.md)

Possible colors:

image

This looks fantastic, thank you! 馃帀馃檹馃徎 I think we'll be getting a logo/favicon made up soon which would look great on this!

@sgibson91 great! Once the logo is created, we can follow these instructions to add it to the badge.

Hi @erictleung 馃憢 We now have a logo! Actually three versions! They're available in this Zenodo repo: https://zenodo.org/record/3695300#.Xmd4LZP7TOQ

I think we should go with LogoNoDetailNoText.jpg since this will be really small 馃槃

I also agree with blueviolet colouring to match our newsletter badge!

@sgibson91 great!

So I've tried taking the LogoNoDetailNoText.jpg file and went through the steps to convert it. But I'm having troubles getting it to work.

As you suggested, the badge will be small. So I've had to do a lot of hacky ways of resizing the image and compressing it to no avail.

Whoever made these, is it possible to create a smaller version? I think these could be nice examples to go off of https://github.com/badges/shields/tree/master/logo. I think a logo of around 40x40 px would be best.

I saw on Zenodo that there is a zip file with SVG files. I thought I could take that and just resize it, but I don't think my graphics skills are good enough to do that.

Hope that all makes sense. If that is too much work, I can always go ahead and create the badge without a logo for now.

Hi @erictleung! Thank you for working on this!

I used https://favicon.io/favicon-converter to convert the image into a bunch of different smaller versions. Would you mind experimenting with them to see which works well?! I think the favicon-32x32 should be good although its very small, so maybe the apple-touch-icon would be better? I've attached the others zipped together in case you want to play around 馃懢

favicon-32x32 馃憠 favicon-32x32
apple-touch-icon 馃憠apple-touch-icon

all the favicons zipped together 馃憠 favicon_io.zip

@KirstieJane thanks! That helped a lot.

Was this page helpful?
0 / 5 - 0 ratings