Skip to content

Add badges to the top of README.md #1064

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

Merged
merged 49 commits into from
Jul 24, 2019
Merged

Add badges to the top of README.md #1064

merged 49 commits into from
Jul 24, 2019

Conversation

QuantumNovice
Copy link
Contributor

The following badges were added

  • Docs
  • Python Version
  • Contributions
  • Hits

@QuantumNovice QuantumNovice changed the title Update README.md Add badges at the top of README.md Jul 24, 2019
@QuantumNovice QuantumNovice changed the title Add badges at the top of README.md Add badges to the top of README.md Jul 24, 2019
@cclauss
Copy link
Member

cclauss commented Jul 24, 2019

Clicking the LGTM badge should link to the LGTM report.

@cclauss
Copy link
Member

cclauss commented Jul 24, 2019

The first word on each badge should be capitalized.

"Gitter" is a brand name so it should be capitalized.

We should use or not use on consistently: Chat "on" Gitter, Tested "on" Python 3.7.

Instead of "Build", can we use "Travis CI" because we currently run both Travis and LGTM?

@QuantumNovice
Copy link
Contributor Author

The first word on each badge should be capitalized.

"Gitter" is a brand name so it should be capitalized.

We should use or not use on consistently: Chat "on" Gitter, Tested "on" Python 3.7.

Instead of "Build", can we use "Travis CI" because we currently run both Travis and LGTM?

On it. Consistency is important.

@cclauss
Copy link
Member

cclauss commented Jul 24, 2019

Extra credit: ?logo=LGTM ?logo=travis ?logo=python ?logo=gitter ?logo=PayPal

Copy link
Member

@cclauss cclauss left a comment

Choose a reason for hiding this comment

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

  • Use or don't use non-blanking space ( ) consistently to put whitespace between badges
  • Remove on from Gitter
  • Limit icons to only one line when viewing the README -- Pick the ones that you think are most important -- We want readers to read the doc, not spend too much time parsing all the badges.

@QuantumNovice
Copy link
Contributor Author

QuantumNovice commented Jul 24, 2019

I kept the repo size. It's important in deciding whether to fork the repo locally or not.

@cclauss
Copy link
Member

cclauss commented Jul 24, 2019

Putting a spacebefore the  add two spaces. Be consistent in spacing.

@QuantumNovice
Copy link
Contributor Author

Putting a spacebefore the  add two spaces. Be consistent in spacing.

Putting a spacebefore the  add two spaces. Be consistent in spacing.

Consistent spaces with &nbsp added.

@cclauss
Copy link
Member

cclauss commented Jul 24, 2019

OK... My last comment is a real nit... Too much green.svg ;-)

@QuantumNovice
Copy link
Contributor Author

OK... My last comment is a real nit... Too much green.svg ;-)

I noticed it but didn't change. Here we go improving on that.

@cclauss
Copy link
Member

cclauss commented Jul 24, 2019

Put PayPal back to green because money is green and then are we DONE?!?

@QuantumNovice
Copy link
Contributor Author

Done. Sorry for inconvenience.

@cclauss
Copy link
Member

cclauss commented Jul 24, 2019

No inconvenience... It is good to get the small things right.

@cclauss
Copy link
Member

cclauss commented Jul 24, 2019

LGTM alerts should point to https://lgtm.com/projects/g/TheAlgorithms/Python/alerts

Copy link
Member

@cclauss cclauss left a comment

Choose a reason for hiding this comment

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

Thanks much!

@cclauss cclauss merged commit 46bcee0 into TheAlgorithms:master Jul 24, 2019
@QuantumNovice QuantumNovice deleted the patch-1 branch July 24, 2019 12:37
stokhos pushed a commit to stokhos/Python that referenced this pull request Jan 3, 2021
* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md
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