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

Showcase two of our distinguishing features #2705

Merged
merged 4 commits into from
Jan 14, 2019
Merged

Conversation

paulmelnikow
Copy link
Member

Vaguely on topic:

  • I think that contributors badge probably should be brightgreen.
  • That commit activity badge looks kind of ugly. Maybe we can put the interval in parentheses or move it to the label. Putting it in parens would be more consistent with the way we handle downloads and such (where it's in the message, not the label).

@paulmelnikow paulmelnikow added the documentation Developer and end-user documentation label Jan 8, 2019
@shields-ci
Copy link

shields-ci commented Jan 8, 2019

Messages
📖 ✨ Thanks for your contribution to Shields, @paulmelnikow!
📖

Thanks for contributing to our documentation. We ❤️ our documentarians!

Generated by 🚫 dangerJS against 5a01dda

@@ -3,13 +3,16 @@
height="130">
</p>
<p align="center">
<a href="https://github.com/badges/shields/graphs/contributors" alt="Contributors">
Copy link
Member

Choose a reason for hiding this comment

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

More general comment, but what do you think about grouping the badges in separate buckets vs all back to back? For example we could have one line (or paragraph) for activity related badges (contributors, commits, sponsors, backers), another line for dev/code metrics (build status, code coverage, service test status, lgtm alerts), and another line for the social badges.

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

I suppose that does end up taking up a lot more vertical real estate so not crazy about that 🤔 I just get used to locating a badge (like coverage or service tests in particular) in a particular location and was trying to think of a way they wouldn't jump around so much when we add new badges

Copy link
Member Author

Choose a reason for hiding this comment

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

We are getting a little bit into https://twitter.com/NikolayTalanov/status/860444084594393088 territory 😁

We could group them into different sections in the readme, like put stuff related to community participation in one place, and stuff related to quality in another. It could be worth having a "maintainers dashboard" in one of the other readme files.

Copy link
Member

Choose a reason for hiding this comment

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

Ah that gave me a good chuckle. I like the idea of a maintainers view too. The ones I check the most are the coverage and build/service test status so would be nice to have somewhere to find those quickly.

Copy link
Member

@calebcartwright calebcartwright left a comment

Choose a reason for hiding this comment

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

These two badges are definitely worth adding, and the current format looks better than what I was thinking so 👍 for me

@paulmelnikow paulmelnikow requested a deployment to shields-staging-pr-2705 January 14, 2019 23:53 Abandoned
@paulmelnikow paulmelnikow merged commit 394a411 into master Jan 14, 2019
@shields-deployment
Copy link

This pull request was merged to master branch. This change is now waiting for deployment, which will usually happen within a few days. Stay tuned by joining our #ops channel on Discord!

After deployment, changes are copied to gh-pages branch:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Developer and end-user documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants