search

DASSL / ClassDB

An open-source system to let students experiment with relational data
https://dassl.github.io/ClassDB/
Other
8 stars 2 forks source link

Readme badges #126

Closed afig closed 7 years ago

afig commented 7 years ago

I have added badges for GitHub, Zenhub, Postgres, and CC.

The text on the GitHub badge is custom, and can easily be changed by modifying the URL of the image. "Project hosting and management by" might be a bit too wordy.

I wonder if there should be another header before the sentence introducing the badges, since it doesn't perfectly fit the "Contributing" section. That sentence before the badges was borrowed from the Credits page on the Wiki/Website, but made in present tense ("is aided" rather than "was aided").

The creative commons badge is near the bottom of the page, under the licensing information.

wildtayne commented 7 years ago

I think it would look better if all the badges were on the same line, although it looks like the Postgres badge being a different height might mess up the alignment. Otherwise, I think it looks good. I don't really think the badges need an additional header since they're in that contrib section anyway.

afig commented 7 years ago

I changed the Postgres badge to a smaller one. It still doesn't line up with the others. I wonder how one of the custom ones would look.

One like this:

wildtayne commented 7 years ago

I like the custom one

smurthys commented 7 years ago

I love the custom Postgres badge. Wish we can find a compatible one for CC.

Yes, the GitHub text is long. I wonder what other people show with GitHub and ZenHub. For GitHub I'd go with "Hosted on". It will be nice if we can get a differerent+shorter phrase for ZenHub.

Show badges in this order, all on the same line: Postgres, GitHub, ZenHub, CC. It will be nice if we found a CC badge of compatible height, but the present one is not bad.

I've seen many READMEs show badges on line 1. If not Line 1, put all the badges on the last line. In any case, remove the text addition made to the "Contributing" section.

On the tense: I have gone back and forth on "is" and "was". I know this is a big ask, but please revise the tense in the opening section of README and Introduction to "is". I think it should remain "was" on the credits page because of the presence of "conceived". Suggestions welcome.

smurthys commented 7 years ago

Wow. This revision looks awesome.

"Hosted by GitHub" or "Hosted on GitHub"?

afig commented 7 years ago

I updated all of the badges to match. The custom badges for Postgres, Github, and License are created with https://shields.io/ . If you scroll down far enough, you will get to a section where you can create your own custom badge. You can also create a badge by simply editing the URL of the image.

As an example, here's the one for Postgres: https://img.shields.io/badge/Powered%20by-PostgreSQL-blue.svg . Changing the text of the URL will change the image (I suppose they are dynamically generated at request-time).

"Hosted on" makes more sense, I will update that now.

afig commented 7 years ago

We could also make a custom one for ZenHub, but I am not sure if they would be 100% okay with that. For example, they always seem to refer to it as "the ZenHub badge" rather than "a ZenHub badge"

smurthys commented 7 years ago

Agree. ZenHub might not be happy if we use any other badge.

Do you want to change the tense in Introduction page as well as detailed above? Any thoughts on the tense in the Credits page? You can also make these changes with the other docs changes.