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

Improve badges in README #1905

Merged
merged 2 commits into from
Sep 25, 2020
Merged

Improve badges in README #1905

merged 2 commits into from
Sep 25, 2020

Conversation

BenHenning
Copy link
Member

README badge updates:

  1. Move them to their own line (I do think this looks better @anandwana001)
  2. Add link to status checks for the status check badge (at the moment it awkwardly links to the badge itself unlike the other badges). Unfortunately, it seems that we can only link to the overall results page rather than the specific failure, but it seems fine the two should be relatively close in result.

README badge updates:
1. Move them to their own line (I do think this looks better @anandwana001)
2. Add link to status checks for the status check badge (at the moment it awkwardly links to the badge itself unlike the other badges). Unfortunately, it seems that we can only link to the overall results page rather than the specific failure, but it seems fine the two should be relatively close in result.
Copy link
Contributor

@anandwana001 anandwana001 left a comment

Choose a reason for hiding this comment

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

This looks clean now. Thanks @BenHenning

Though I am adding a few suggestions

As Gitter's key colour
Gitter


In future we can add Oppia complete logo or when we have a banner image, we can add that.


The sequence will be good this way, keeping all badges together and twitter at last.
CI Lint and Tests Gitter Mailing List GitHub issues by-label Twitter Follow

@BenHenning
Copy link
Member Author

Ah, @anandwana001 where do you think the banner should go? The title should probably be 'Oppia Android'.

Also I'm not sure I understand the color comment--should we be using the color you suggested? They look close to me, so I wasn't sure.

@anandwana001
Copy link
Contributor

Ah, @anandwana001 where do you think the banner should go? The title should probably be 'Oppia Android'.

Also I'm not sure I understand the color comment--should we be using the color you suggested? They look close to me, so I wasn't sure.

A banner can go at the very top, currently, I don't think we have any banner available, but once in future we have we can add it.


Oppia Android


Currently, we have this
Gitter

And I am thinking to go for this
Gitter

@BenHenning
Copy link
Member Author

Ah, I just realize what confused me about the color thing. That makes sense, thanks!

And got it re: the banner. I think it's a bit redundant to have Oppia in 2 places, but maybe we could put it farther down in the readme.

Update Gitter badge color.
@BenHenning
Copy link
Member Author

Going ahead and merging this once the checks pass. Thanks again @anandwana001!

@BenHenning BenHenning merged commit 921f00a into develop Sep 25, 2020
@BenHenning BenHenning deleted the update-readme-badges branch September 25, 2020 05:22
prayutsu pushed a commit to prayutsu/oppia-android that referenced this pull request Sep 25, 2020
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.

2 participants