Skip to content

Add pre-commit badge#1334

Merged
asottile merged 1 commit into
pre-commit:masterfrom
ddelange:badge
Feb 14, 2020
Merged

Add pre-commit badge#1334
asottile merged 1 commit into
pre-commit:masterfrom
ddelange:badge

Conversation

@ddelange

Copy link
Copy Markdown
Contributor

Since I like pretty badges, I decided to request your logo be added to simple-icons (simple-icons/simple-icons#2475) for use with shields.io.

Since I think badges are a perfect way to promote technologies and provide insights, I wanted your badge to shine as well. Having it in your README will maybe also inspire other devs to adopt it and spread the word!

I'm also interested in other wordings than enabled or available, maybe you have a nice idea?

@asottile

Copy link
Copy Markdown
Member

neat! let's add this to the docs instead: https://github.com/pre-commit/pre-commit.github.io -- pre-commit/pre-commit.com#194

(I personally don't really like adding badges to my READMEs but I think others would appreciate this!)

can add some sample markdown / rst / etc. as well -- let me know if you'd like some help documenting this and greatly appreciate the work you've put into this 🎉

@ddelange

Copy link
Copy Markdown
Contributor Author

Sure! I'll open a PR for the website. Would you like to merge this PR anyway? I think this will be the landing page for many people (e.g. all the people that will be clicking the badge ^^). Or would you like to link it to pre-commit.com?

I'll add the badge on pre-commit.com. Can you give me a gitlink to where you would like to see a code block with badge code examples?

@asottile asottile left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@asottile

Copy link
Copy Markdown
Member

yeah we can have just this one -- let me find where we'd want to put this in the docs 🤔

@asottile

Copy link
Copy Markdown
Member

can probably add it right before this section here: https://github.com/pre-commit/pre-commit.github.io/blob/4250dada78f819b59b20a6d80027178fb7797cc1/index.mako#L1432

I think linking to github is fine, that way they can star and click through to the docs if they want

@asottile asottile merged commit dbdb8f7 into pre-commit:master Feb 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants