feat(docs): Add repo stats badges #6697

davorpa · 2022-02-06T12:40:04Z

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:

Read our contributing guidelines
Search for duplicates. proposal(docs): repository badges #5983 -> Add badges #6631 -> format: center repo badges #6662
Decide the badges format.
Decide some colors (logo / backgrounds).
Decide which are usefull (eg: by labels)
Decide the most meaningful place of each one (README, HOWTO, CONTRIBUTING....)
How much badges by row or how to group addressing responsivenes (wide-narrow screens)?
Build / linter status badge ???
Recover Contribution Covenant badge seen at proposal(docs): repository badges #5983 (comment)

Follow-up

Check the status of GitHub Actions and resolve any reported warnings!

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

davorpa · 2022-02-06T12:43:50Z

NOTE

Needs consensuate what are usefull (see pending tasks)

LuigiImVector · 2022-02-06T13:05:47Z

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

    
           The list was moved to GitHub by Victor Felder for collaborative updating and maintenance. It has grown to become one of [GitHub's most popular repositories](https://octoverse.github.com/), with 221,000+ stars, 6,900+ commits, 1,900+ contributors, and 47,100+ forks.

There would be too much redundancy of information otherwise.

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

davorpa · 2022-02-06T14:01:47Z

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

The list was moved to GitHub by Victor Felder for collaborative updating and maintenance. It has grown to become one of [GitHub's most popular repositories](https://octoverse.github.com/), with 221,000+ stars, 6,900+ commits, 1,900+ contributors, and 47,100+ forks.

There would be too much redundancy of information otherwise.

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

LuigiImVector · 2022-02-06T14:50:44Z

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

eshellman · 2022-02-06T19:53:07Z

looks very cluttered. mostly redundant, but I wouldn't object to surfacing the sponsors.

README.md

CleanMachine1 · 2022-02-06T20:03:25Z

Personally, I only like

The license
stars forks and watchers
the amount of issues and prs
and the contributors
The rest seem like surplus content which don't add much IMO

- 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

davorpa · 2022-02-07T06:21:10Z

How looks now?

Better group using paragraphs or by brs like before? Looks a bit gapped

Click to see details about screenshot

eshellman · 2022-02-07T15:58:18Z

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

davorpa · 2022-02-08T00:11:10Z

looks very cluttered. mostly redundant, but I wouldn't object to surfacing the sponsors.

After c600455 commit, it appears a bit less cluttered. Somebody are agree?

Takes up too much space. One row max. We can fit 3 badges. or send to the bottom of the page.

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

eshellman · 2022-02-08T00:57:00Z

Would welcome comments from the community

CleanMachine1 · 2022-02-08T19:32:51Z

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

LuigiImVector · 2022-02-09T19:17:21Z

After c600455 commit, it appears a bit less cluttered. Somebody are agree?

seem more orderly even if they are still too many

davorpa · 2022-02-10T06:01:36Z

Maybe some of these badges could be moved such as the help wanted ones to the CONTRIBUTING.md file, it seems more fitting.

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

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.

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

README.md

Co-authored-by: CleanMachine1 <[email protected]>

CleanMachine1 · 2022-03-10T23:00:10Z

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

davorpa · 2022-03-11T08:12:08Z

@EbookFoundation/reviewers and something like this. It seems less dense, I thought. Each badge in their respective section

Click to see details about screenshot

eshellman · 2022-03-11T14:29:09Z

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]

davorpa · 2022-03-11T16:29:24Z

MUCH better! Remove or move the "Website up" and the "Contributor covenant" badges, and I think we're set.

@eshellman check it now again: https://davorpa.github.io/free-programming-books

LuigiImVector · 2022-03-11T19:14:32Z

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

I also think that there are too many badges

README.md

davorpa added 10 commits February 6, 2022 08:32

add forks count badges

f646dab

Add stargazers counter badge

deade65

Add repo size badge

78ac6f6

pointing to main branch download

add sponsors count badge

adce57b

- link points to sponsorized profile page - render version is placed at new line.

Add open issues counter badges

6b48139

- With social balloon style - link points to its filter: open & "help wanted" - in a new line

Add pull request count badges

1e1d2d5

- by filter: open, merged, "help wanted" - using social balloon style - linked with its own query filter - in a new line

Add watchers count badge

a03e087

Add website status badge

fcd40f1

- link points to the github.io version of the repo

Add contributions count badge

b6dab90

Use nonbreak spaces to separate badges

58a9a20

davorpa self-assigned this Feb 6, 2022

davorpa added the 👥 discussion This Repo is guided by its community! Let's talk! label Feb 6, 2022

davorpa mentioned this pull request Feb 6, 2022

proposal(docs): repository badges #5983

Closed

davorpa marked this pull request as ready for review February 6, 2022 12:42

davorpa added the 👀 Needs Review Is this really a good resource? Reviews requested. label Feb 6, 2022

davorpa added 3 commits February 6, 2022 14:30

Add contribution covenant 1.3 badge

bf8a749

Shorten longer "Help Wanted" Pull Request badge text

644b4d6

Add good first issues count badge

9c7e77c

- It links to related issue search query

CleanMachine1 reviewed Feb 6, 2022

View reviewed changes

README.md Outdated Show resolved Hide resolved

format clean cluttered

dd893ef

- 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

davorpa added 2 commits February 7, 2022 23:29

format: less gap flow

c600455

change logo for website badge to www

d141e97

a PR submit into @badges/shields project is pending to be rendered

davorpa added the help wanted Needs help solving a blocked / stucked item label Feb 8, 2022

CleanMachine1 reviewed Mar 9, 2022

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update repo stats counters + fix typos

f5cd8d4

Co-authored-by: CleanMachine1 <[email protected]>

davorpa requested a review from CleanMachine1 March 10, 2022 08:44

transfer each badge to its section. now seems less dense

523eda9

davorpa added the conflicts Conflict(s) need to be resolved label Mar 11, 2022

Merge branch 'main' into docs/repo-statistics-badges

edcaeaa

davorpa removed the conflicts Conflict(s) need to be resolved label Mar 11, 2022

davorpa added 2 commits March 11, 2022 16:06

Fix markdownlint issues

c2e9038

- 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]

move website status badge near to its paragraph

8ebfc4d

davorpa requested a review from eshellman March 11, 2022 15:47

transfer CoC badge near to its paragraph/link

2e593a2

davorpa force-pushed the docs/repo-statistics-badges branch from 535a5e6 to 2e593a2 Compare March 11, 2022 16:43

reword website badge

898f927

davorpa force-pushed the docs/repo-statistics-badges branch from 8ec0765 to 898f927 Compare March 13, 2022 08:52

eshellman reviewed Mar 14, 2022

View reviewed changes

README.md Outdated Show resolved Hide resolved

Reword issues/PRs badge preface

6a67c08

davorpa requested a review from eshellman March 14, 2022 15:27

eshellman merged commit 3fdb16f into EbookFoundation:main Mar 15, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(docs): Add repo stats badges #6697

feat(docs): Add repo stats badges #6697

davorpa commented Feb 6, 2022 •

edited

Loading

davorpa commented Feb 6, 2022

LuigiImVector commented Feb 6, 2022

davorpa commented Feb 6, 2022

LuigiImVector commented Feb 6, 2022

eshellman commented Feb 6, 2022

CleanMachine1 commented Feb 6, 2022 •

edited

Loading

davorpa commented Feb 7, 2022 •

edited

Loading

eshellman commented Feb 7, 2022

davorpa commented Feb 8, 2022

eshellman commented Feb 8, 2022

CleanMachine1 commented Feb 8, 2022

LuigiImVector commented Feb 9, 2022

davorpa commented Feb 10, 2022

CleanMachine1 commented Mar 10, 2022

davorpa commented Mar 11, 2022 •

edited

Loading

eshellman commented Mar 11, 2022

davorpa commented Mar 11, 2022 •

edited

Loading

LuigiImVector commented Mar 11, 2022

feat(docs): Add repo stats badges #6697

feat(docs): Add repo stats badges #6697

Conversation

davorpa commented Feb 6, 2022 • edited Loading

What does this PR do?

For resources

Description

Checklist:

Follow-up

davorpa commented Feb 6, 2022

NOTE

LuigiImVector commented Feb 6, 2022

davorpa commented Feb 6, 2022

LuigiImVector commented Feb 6, 2022

eshellman commented Feb 6, 2022

CleanMachine1 commented Feb 6, 2022 • edited Loading

davorpa commented Feb 7, 2022 • edited Loading

eshellman commented Feb 7, 2022

davorpa commented Feb 8, 2022

eshellman commented Feb 8, 2022

CleanMachine1 commented Feb 8, 2022

LuigiImVector commented Feb 9, 2022

davorpa commented Feb 10, 2022

CleanMachine1 commented Mar 10, 2022

davorpa commented Mar 11, 2022 • edited Loading

eshellman commented Mar 11, 2022

davorpa commented Mar 11, 2022 • edited Loading

LuigiImVector commented Mar 11, 2022

davorpa commented Feb 6, 2022 •

edited

Loading

CleanMachine1 commented Feb 6, 2022 •

edited

Loading

davorpa commented Feb 7, 2022 •

edited

Loading

davorpa commented Mar 11, 2022 •

edited

Loading

davorpa commented Mar 11, 2022 •

edited

Loading