-
-
Notifications
You must be signed in to change notification settings - Fork 61.1k
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
feat(docs): Add repo stats badges #6697
feat(docs): Add repo stats badges #6697
Conversation
pointing to main branch download
- link points to sponsorized profile page - render version is placed at new line.
- With social balloon style - link points to its filter: open & "help wanted" - in a new line
- by filter: open, merged, "help wanted" - using social balloon style - linked with its own query filter - in a new line
- link points to the github.io version of the repo
NOTENeeds consensuate what are usefull (see pending tasks) |
I like the badges regarding the number of forks, stars and watchers but I think they should be added only if the stats are removed from the (maybe also adding the number of contributions, commits and merged PRs): free-programming-books/README.md Line 18 in c524edd
I find instead useful badges regarding the "help wanted", would help new contributors to understand what to do. For the style: the same color should be used for everything (gray and blue/light gray, for example) and the size should be the same. |
- It links to related issue search query
I agree too in pro of automatize things in a future 🚀 but the text will be lost for blind users using readable browsers like JAWS |
maybe these stats can read them from the official github buttons, although it may be slower and more difficult, idk |
looks very cluttered. mostly redundant, but I wouldn't object to surfacing the sponsors. |
Personally, I only like
|
- flat style for all badges - fix some target urls (CoC, contribs) - organize url parameters - capitalize labels - move contrib/sponsors nest to forks/stars... - group by paragraph instead of br
Takes up too much space. One row max. We can fit 3 badges. or send to the bottom of the page. |
a PR submit into @badges/shields project is pending to be rendered
After c600455 commit, it appears a bit less cluttered. Somebody are agree?
Issues and PR badges could be moved to Contributing section, I thought. But I'm in pro of having all badges glued. From the point of view of UX, remember that the intention of counter badges is also have a link to, at a glance, easily navigate to that section. Try links and let me know some options more |
Would welcome comments from the community |
My personal opinion on these badges is there current amount seem unprofessional and cluttering, like they are there to purely fill more space. Maybe some of these badges could be moved such as the help wanted ones to the CONTRIBUTING.md file, it seems more fitting. I'd also opt to remove the good first issue, it has been used less than 20 times in this projects entire existence from what I can tell so its pretty redundant. Other than them small issues, LGTM |
seem more orderly even if they are still too many |
I agree too. My feelings: The inconvenient maybe the amout of files to apply to, one of the reason to agree form, temp and space where place it and then avoid alter them again
Well, issues and PRs counters are informative too. 2x3 grid. "Good first issue" aren't used too much, I thought, because there aren't enough issues yet and this project isn't "really" a coding project, reducing a bit more its amount. But can be used to mark as easy thing to resolve. Eg: see hacktoberfest backlog #5762 pending tasks |
Co-authored-by: CleanMachine1 <[email protected]>
I still have to say, there is an excessive amount of badges, so until we find a solution, I can't agree with the addition |
MUCH better! Remove or move the "Website up" and the "Contributor covenant" badges, and I think we're set. |
- MD041/first-line-heading/first-line-h1: First line in a file should be a top-level heading - MD009/no-trailing-spaces: Trailing spaces [Expected: 0 or 4; Actual: 2]
@eshellman check it now again: https://davorpa.github.io/free-programming-books |
535a5e6
to
2e593a2
Compare
I also think that there are too many badges |
8ec0765
to
898f927
Compare
What does this PR do?
Add info | Improve repo
For resources
Description
Completes a bit more the counters about the repository using badges provided by the https://img.shields.io service:
A preview about GHP rendering: https://davorpa.github.io/free-programming-books/
Checklist:
Follow-up