feat: remove 'include_private' #2736

rickstaa · 2023-05-19T08:26:18Z

As explained in #2517 the 'include_private' flag is confusing and doesn't work as expected. This commit therefore removes this flag.

TODOs

remove conflicts.
Update FAQ.

As explained in #2517 the 'include_private' flag is confusing and doesn't work as expected. This commit therefore removes this flag.

vercel · 2023-05-19T08:26:23Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
github-readme-stats	✅ Ready (Inspect)	Visit Preview	Jun 7, 2023 8:17am

rickstaa · 2023-05-19T08:29:17Z

@qwerty541 @anuraghazra told me he will add you as a collaborator when he finds the time. I was curious to know what you think about this change?

codecov · 2023-05-19T08:31:41Z

Codecov Report

Patch coverage has no change and project coverage change: +0.05 🎉

Comparison is base (0fe51cd) 97.53% compared to head (a35b8e5) 97.59%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2736      +/-   ##
==========================================
+ Coverage   97.53%   97.59%   +0.05%     
==========================================
  Files          24       24              
  Lines        4824     4814      -10     
  Branches      449      447       -2     
==========================================
- Hits         4705     4698       -7     
+ Misses        118      115       -3     
  Partials        1        1

Impacted Files	Coverage Δ
api/index.js	`96.03% <ø> (-0.08%)`	⬇️
src/fetchers/stats-fetcher.js	`92.66% <ø> (+0.90%)`	⬆️

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

qwerty541

@anuraghazra told me he will add you as a collaborator when he finds the time.

Nice

I was curious to know what you think about this change?

I fully agree that the count_private parameter has behavior that confuse users and support the course to change how it works. But it is important to consider that a large number of users still want to be able to add their private contributions to the statistics card, and I am one of them. As far as I understand, this pull request is a preparation step for adding the optional ability to display the value of the total contributions, including private ones, on the statistics card. If I understood everything correctly, then I support this change.

I can also add that I think it's good practice for a pull request to contain changes related to only one small task. If I were you, I would format the readme file in a separate pull request so that changes are not confusing.

rickstaa · 2023-05-25T06:24:18Z

@anuraghazra told me he will add you as a collaborator when he finds the time.

Nice

I was curious to know what you think about this change?

I fully agree that the count_private parameter has behavior that confuse users and support the course to change how it works. But it is important to consider that a large number of users still want to be able to add their private contributions to the statistics card, and I am one of them. As far as I understand, this pull request is a preparation step for adding the optional ability to display the value of the total contributions, including private ones, on the statistics card. If I understood everything correctly, then I support this change.

I can also add that I think it's good practice for a pull request to contain changes related to only one small task. If I were you, I would format the readme file in a separate pull request so that changes are not confusing.

@qwerty541 This pull request was meant to remove the count_private flag all together, as we don't have permissions to view a user's private commits. Users that want to include private commits therefore have to deploy their own Vercel instance. However, You are welcome to create a pull request that shows contributions instead of commits (see #2517 (comment)) 👍🏻.

francois-rozet · 2023-05-30T03:43:18Z

I also think displaying contributions instead of commits would be better as some users mainly have private contribs. However this will generate a lot of questions from users. Note that "contributed to" can also be replaced by "repositories" to avoid confusions (while still counting the repositories that were contributed to).

rickstaa · 2023-05-30T07:09:00Z

I also think displaying contributions instead of commits would be better as some users mainly have private contribs. However this will generate a lot of questions from users. Note that "contributed to" can also be replaced by "repositories" to avoid confusions (while still counting the repositories that were contributed to).

@francois-rozet Thanks for your feedback 💪🏻!

Users can already show private commits by deploying their own Vercel instance. However, as stated above, I agree that giving users the ability to also show contributions using the show_contribs and include_private_contribs flags while removing the include_private flag will be great 🚀! If anybody wants to take this one, feel free to create a pull request.

francois-rozet · 2023-05-30T07:45:06Z

Would show_contribs replace the commit field or add a new field? Also, we should directly count the private contributions instead of adding a flag include_private_contribs. I don't think anyone would choose to not count them if they are set as public in their GitHub profile.

rickstaa · 2023-05-30T07:53:12Z

Would show_contribs replace the commit field or add a new field? Also, we should directly count the private contributions instead of adding a flag include_private_contribs. I don't think anyone would choose to not count them if they are set as public in their GitHub profile.

Ideally, I think it would be an extra statistics people can enable. People can then disable the commits if they like, using the hide flag. I agree that the include_private_contribs flag is not needed 😅!

francois-rozet · 2023-05-30T07:57:19Z

I am not familiar with that part of the API (adding a new field to the card), but I can do the "backend" part if needed. Or you can point me to where I can modify the card.

rickstaa · 2023-05-30T08:22:28Z

I am not familiar with that part of the API (adding a new field to the card), but I can do the "backend" part if needed. Or you can point me to where I can modify the card.

It would, of course, be great if you could create a pull request, but don't feel pressured 👍🏻. The stats card items are added in:

github-readme-stats/src/cards/stats-card.js

Lines 191 to 203 in 275c1fc

    
           const statItems = Object.keys(STATS) 
        
             .filter((key) => !hide.includes(key)) 
        
             .map((key, index) => 
        
               // create the text nodes, and pass index so that we can calculate the line spacing 
        
               createTextNode({ 
        
                 ...STATS[key], 
        
                 index, 
        
                 showIcons: show_icons, 
        
                 shiftValuePos: 79.01 + (isLongLocale ? 50 : 0), 
        
                 bold: text_bold, 
        
                 number_format, 
        
               }), 
        
             );

Please don't hesitate to request any help you need.

rickstaa · 2023-05-30T08:24:03Z

I updated the CONTRIBUTING.md some weeks ago also to explain how people can use a debugger with the project might that be helpful.

qwerty541 · 2023-06-04T03:03:49Z

@anuraghazra told me he will add you as a collaborator when he finds the time.

Nice

I was curious to know what you think about this change?

I fully agree that the count_private parameter has behavior that confuse users and support the course to change how it works. But it is important to consider that a large number of users still want to be able to add their private contributions to the statistics card, and I am one of them. As far as I understand, this pull request is a preparation step for adding the optional ability to display the value of the total contributions, including private ones, on the statistics card. If I understood everything correctly, then I support this change.
I can also add that I think it's good practice for a pull request to contain changes related to only one small task. If I were you, I would format the readme file in a separate pull request so that changes are not confusing.

@qwerty541 This pull request was meant to remove the count_private flag all together, as we don't have permissions to view a user's private commits. Users that want to include private commits therefore have to deploy their own Vercel instance. However, You are welcome to create a pull request that shows contributions instead of commits (see #2517 (comment)) 👍🏻.

I looked a little deeper and realized that the main problem with the count_private parameter is not that its behavior is not obvious to users, but that because of it, when using your own vercel instance, the statistics card shows false information. When using your own vercel instance, the statistics card already shows all private contributions, and the count_private parameter adds redundant commits that are already taken into account there. Now I fully agree that this parameter should be removed.

rickstaa · 2023-06-05T10:09:01Z

@anuraghazra told me he will add you as a collaborator when he finds the time.

Nice

I was curious to know what you think about this change?

I fully agree that the count_private parameter has behavior that confuse users and support the course to change how it works. But it is important to consider that a large number of users still want to be able to add their private contributions to the statistics card, and I am one of them. As far as I understand, this pull request is a preparation step for adding the optional ability to display the value of the total contributions, including private ones, on the statistics card. If I understood everything correctly, then I support this change.
I can also add that I think it's good practice for a pull request to contain changes related to only one small task. If I were you, I would format the readme file in a separate pull request so that changes are not confusing.

@qwerty541 This pull request was meant to remove the count_private flag all together, as we don't have permissions to view a user's private commits. Users that want to include private commits therefore have to deploy their own Vercel instance. However, You are welcome to create a pull request that shows contributions instead of commits (see #2517 (comment)) 👍🏻.

I looked a little deeper and realized that the main problem with the count_private parameter is not that its behavior is not obvious to users, but that because of it, when using your own vercel instance, the statistics card shows false information. When using your own vercel instance, the statistics card already shows all private contributions, and the count_private parameter adds redundant commits that are already taken into account there. Now I fully agree that this parameter should be removed.

Great! I will merge this pull request when I get a review from @anuraghazra or @Zo-Bro-23 👍🏻.

qwerty541 · 2023-06-07T07:24:33Z

Hey, @rickstaa! You need to resolve conflicts before merging.

rickstaa · 2023-06-07T07:46:19Z

Hey, @rickstaa! You need to resolve conflicts before merging.

Of course! Sorry, here you go 😄.

readme.md

* feat: remove 'include_private' As explained in anuraghazra#2517 the 'include_private' flag is confusing and doesn't work as expected. This commit therefore removes this flag. * fix: fix tests * docs: remove redundant private deploy note

This reverts commit b9200c6.

- add card_width - remove count_private ref: anuraghazra/github-readme-stats#2736

* feat: remove 'include_private' As explained in anuraghazra#2517 the 'include_private' flag is confusing and doesn't work as expected. This commit therefore removes this flag. * fix: fix tests * docs: remove redundant private deploy note

This is now being handled directly by self-hosting anuraghazra/github-readme-stats#2736

…k Staa <rick.staa@outlook.com> 7 Jun 2023 at 10:21

* feat: remove 'include_private' As explained in anuraghazra#2517 the 'include_private' flag is confusing and doesn't work as expected. This commit therefore removes this flag. * fix: fix tests * docs: remove redundant private deploy note

feat: remove 'include_private'

4af416a

As explained in #2517 the 'include_private' flag is confusing and doesn't work as expected. This commit therefore removes this flag.

github-actions bot added the documentation Improvements or additions to documentation. label May 19, 2023

vercel bot deployed to Preview May 19, 2023 08:26 View deployment

rickstaa mentioned this pull request May 19, 2023

I think we should remove the count_private option altogether, unless we plan to add a totalContributions field in the future. #2517

Closed

rickstaa requested review from Zo-Bro-23 and anuraghazra May 19, 2023 08:27

fix: fix tests

de80dc4

vercel bot deployed to Preview May 19, 2023 08:30 View deployment

rickstaa mentioned this pull request May 19, 2023

Ranking System v2 #1186

Merged

qwerty541 reviewed May 20, 2023

View reviewed changes

rickstaa mentioned this pull request Jun 5, 2023

GitHub Stats are not Getting Updated #2769

Closed

rickstaa requested a review from qwerty541 June 7, 2023 06:49

vercel bot deployed to Preview June 7, 2023 07:37 View deployment

rickstaa marked this pull request as draft June 7, 2023 07:37

rickstaa force-pushed the remove_include_private branch from 2db6cf7 to 30fd5c8 Compare June 7, 2023 07:42

vercel bot deployed to Preview June 7, 2023 07:42 View deployment

vercel bot deployed to Preview June 7, 2023 07:45 View deployment

Merge branch 'master' into remove_include_private

0c3aa0f

rickstaa force-pushed the remove_include_private branch from 7c4c70a to 0c3aa0f Compare June 7, 2023 07:45

rickstaa marked this pull request as ready for review June 7, 2023 07:45

vercel bot deployed to Preview June 7, 2023 07:45 View deployment

qwerty541 reviewed Jun 7, 2023

View reviewed changes

readme.md Outdated Show resolved Hide resolved

Merge remote-tracking branch 'origin' into remove_include_private

ecdf2ed

vercel bot deployed to Preview June 7, 2023 08:16 View deployment

docs: remove redundant private deploy note

a35b8e5

rickstaa force-pushed the remove_include_private branch from 5886567 to a35b8e5 Compare June 7, 2023 08:16

vercel bot deployed to Preview June 7, 2023 08:17 View deployment

rickstaa requested a review from qwerty541 June 7, 2023 08:17

qwerty541 approved these changes Jun 7, 2023

View reviewed changes

qwerty541 merged commit b9200c6 into master Jun 7, 2023

rickstaa deleted the remove_include_private branch June 7, 2023 08:25

rickstaa mentioned this pull request Jun 9, 2023

Personal Instance with Repo Access PAT Cannot Read Yearly Commit Correctly #2793

Closed

qwerty541 mentioned this pull request Jun 15, 2023

update README: counting the private contributions #1714

Closed

demirmusa added a commit to demirmusa/github-readme-stats that referenced this pull request Jun 15, 2023

Revert "feat: remove 'include_private' (anuraghazra#2736)"

3fc8e1b

This reverts commit b9200c6.

qwerty541 mentioned this pull request Jun 23, 2023

Cards not updating if information changes. #275

Closed

rickstaa mentioned this pull request Jul 14, 2023

Need Top Languages card to include stats for private repos #653

Closed

commit-lint bot mentioned this pull request Aug 21, 2023

[pull] master from anuraghazra:master Crushoverride007/readme-stats#2

Open

anyesu added a commit to anyesu/anyesu that referenced this pull request Sep 4, 2023

Update README.md

054a983

- add card_width - remove count_private ref: anuraghazra/github-readme-stats#2736

paddyroddy added a commit to paddyroddy/paddyroddy that referenced this pull request Nov 7, 2023

Disable count_private badge

763e835

This is now being handled directly by self-hosting anuraghazra/github-readme-stats#2736

paddyroddy mentioned this pull request Nov 7, 2023

Disable count_private badge paddyroddy/paddyroddy#13

Merged

Ganbin added a commit to Ganbin/github-readme-stats that referenced this pull request Dec 22, 2023

reverse feat: remove 'include_private' (anuraghazra#2736) b9200c6 Ric…

95ceac8

…k Staa <rick.staa@outlook.com> 7 Jun 2023 at 10:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: remove 'include_private' #2736

feat: remove 'include_private' #2736

rickstaa commented May 19, 2023 •

edited

Loading

vercel bot commented May 19, 2023 •

edited

Loading

rickstaa commented May 19, 2023

codecov bot commented May 19, 2023 •

edited

Loading

qwerty541 left a comment

rickstaa commented May 25, 2023 •

edited

Loading

francois-rozet commented May 30, 2023 •

edited

Loading

rickstaa commented May 30, 2023

francois-rozet commented May 30, 2023 •

edited

Loading

rickstaa commented May 30, 2023 •

edited

Loading

francois-rozet commented May 30, 2023 •

edited

Loading

rickstaa commented May 30, 2023

rickstaa commented May 30, 2023

qwerty541 commented Jun 4, 2023

rickstaa commented Jun 5, 2023

qwerty541 commented Jun 7, 2023

rickstaa commented Jun 7, 2023

feat: remove 'include_private' #2736

feat: remove 'include_private' #2736

Conversation

rickstaa commented May 19, 2023 • edited Loading

TODOs

vercel bot commented May 19, 2023 • edited Loading

rickstaa commented May 19, 2023

codecov bot commented May 19, 2023 • edited Loading

Codecov Report

qwerty541 left a comment

Choose a reason for hiding this comment

rickstaa commented May 25, 2023 • edited Loading

francois-rozet commented May 30, 2023 • edited Loading

rickstaa commented May 30, 2023

francois-rozet commented May 30, 2023 • edited Loading

rickstaa commented May 30, 2023 • edited Loading

francois-rozet commented May 30, 2023 • edited Loading

rickstaa commented May 30, 2023

rickstaa commented May 30, 2023

qwerty541 commented Jun 4, 2023

rickstaa commented Jun 5, 2023

qwerty541 commented Jun 7, 2023

rickstaa commented Jun 7, 2023

rickstaa commented May 19, 2023 •

edited

Loading

vercel bot commented May 19, 2023 •

edited

Loading

codecov bot commented May 19, 2023 •

edited

Loading

rickstaa commented May 25, 2023 •

edited

Loading

francois-rozet commented May 30, 2023 •

edited

Loading

francois-rozet commented May 30, 2023 •

edited

Loading

rickstaa commented May 30, 2023 •

edited

Loading

francois-rozet commented May 30, 2023 •

edited

Loading