Docs: add warning about top languages card behavior. #2789
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
github-actions
bot
added
the
documentation
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## master #2789 +/- ##
=======================================
Coverage 97.59% 97.59%
=======================================
Files 24 24
Lines 4814 4814
Branches 447 447
=======================================
Hits 4698 4698
Misses 115 115
Partials 1 1 ☔ View full report in Codecov by Sentry. |
readme.md
Outdated
| @@ -357,6 +357,9 @@ The top languages card shows a GitHub user's most frequently used top language. | |||
| > **Note** | |||
| > Top Languages does not indicate the user's skill level or anything like that; it's a GitHub metric to determine which languages have the most code on GitHub. It is a new feature of github-readme-stats. | |||
|
|
|||
| > **Warning** | |||
| > This card shows languages usage only inside your own non-forked repositories, not depending from who is the author of the commits. It does not include your contributions into another users/organizations repositories. If you have a technical solution how to improve this behavior share it with us by opening issue or discussion. | |||
There was a problem hiding this comment.
Sadly, last time I checked, adding the forks will make the language results even worse. The only solution is to parse all the users' commits, which is not possible with the current GraphQL and time limits. I created https://github.com/orgs/community/discussions/18230 as a feature request for GitHub to solve this.
There was a problem hiding this comment.
I therefore do not know if we should invite people to propose solutions. We can, however, state that due to current GraphQL and timeout limits, including forks or organization repositories is not feasible and that if people want this implemented they should show their support in https://github.com/orgs/community/discussions/18230? Something along that line?
There was a problem hiding this comment.
I didn't knew about this feature request. You are right, it is better to invite people to show support in this discussion. I have updated the code, please take a look.
…readme_about_languages_card_behavior
rickstaa
deleted the
add_warning_into_readme_about_languages_card_behavior
branch
* feat: add CACHE_SECONDS environment variable (anuraghazra#2266) * feat: add CACHE_SECONDS environment variable This commit adds the CACHE_SECONDS environment variable. This variable can be used to circumvent our cache clamping values for self hosted Vercel instances. * refactor: apply formatter * Remove redundant ask for theme screenshot from CONTRIBUTING.md (anuraghazra#2797) * Fix clampValue function docstring (anuraghazra#2796) * Docs: add warning about top languages card behavior. (anuraghazra#2789) * Docs: add warning about top languages card behavior. * dev * dev * Update readme.md about maxDuration (anuraghazra#2792) * Update readme.md about maxDuration I think we can remove this warning section since that value in `.json` has been changed to 10 by default nowadays? * Update readme.md remove related section in self deployment section as well * docs: add inverse maxDuration warning --------- Co-authored-by: rickstaa <rick.staa@outlook.com> * docs: add package debug steps to contribution guidelines (anuraghazra#2798) * Beautify themes contribution note inside CONTRIBUTING.md (anuraghazra#2800) --------- Co-authored-by: Rick Staa <rick.staa@outlook.com> Co-authored-by: Alexandr Garbuzov <qwerty541zxc@gmail.com> Co-authored-by: しぐれ <23041178+ForsakenRei@users.noreply.github.com>
* Docs: add warning about top languages card behavior. * dev * dev
* Docs: add warning about top languages card behavior. * dev * dev
No description provided.