Repositories contributed to is only the last year

[vsoch]

It looks like repositories contributed to is only the last year:

jstrieb/github-stats#13

eg for mine, how could I have almost 700 but only have contributed to ~270?

I think this is still a good useful stat, but perhaps it should be made more obvious this is in the last year, because for most of the cards I’ve seen the number looks erroneously small. Maybe just “Contributed last year” or similar, or a mouse over information pop up that clarifies it?

Thanks for making this I really like having it in my profile!

[rickstaa]

@vsoch Thanks for bringing this error to our attention. I checked the GraphQL API in the GraphQL explorer, and it seems that it only returns the contributions in the last year, while I would have expected the repositoriesContributedTo.totalCount to return all of a user's contributions.

query userInfo($login: String!) {
  user(login: $login) {
    name
    repositoriesContributedTo(
      contributionTypes: [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY]
    ) {
      totalCount
    }
  }
}

{
  "login": "vsoch"
}

I checked the GraphQL documentation, and GitHub states the following:

A list of repositories that the user recently contributed to.

They, unfortunately, don't elaborate on the meaning of recently but it seems to be the last year. This is in line with the period of the other GraphQL objects and was discussed in community/community#24350.

I checked both GitHub's GraphQL and Rest APIs, but I could not find an easy way to get all the repositories a user has contributed to. The only way I currently found for retrieving the total number of repositories a user has contributed to is looping through all years in the contributionsCollection.totalRepositoriesWithContributedCommits object via the from and to arguments.

query userInfo($login: String!) {
  user(login: $login) {
    name
    repositoriesContributedTo(
      contributionTypes: [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY]
    ) {
      totalCount
    }
    contributionsCollection(from:"2020-11-20T15:45:00.000Z", to:"2021-11-20T15:45:00.000Z") {
      totalRepositoriesWithContributedCommits
    }
  }
}

This is similar to what is done in #1691. Still, this solution is only feasible in self-deployed Vercel instances and the upcoming github action since, in the Public example, this change will likely trigger the GraphQL and Vercel rate/timeout limits. If you find a way, please let me know. I think, for now, the best we can do is:

• For the public Vercel instance, add a (last year) comment to the Contributed to item to prevent confusion. This is similar to what

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

  Line 137 in de4cefa

  include_all_commits ? "" : year ? ` (${year})` : ` (last year)`

  proposes for the total commits item.

• Add a feature request to git https://github.com/community/community/discussions asking for an easy way to retrieve the total repositories a user has contributed to and update the documentation. For example, by adding date selectors (i.e. from and to) to the repositoriesContributedTo object.

  UPDATE: I just created [feature_request] Add date selector arguments to GraphQL repositoriesContributedTo object community/community#39589.

• Implement a function that loops through the years and sums the result of repositoriesContributedTo.totalCount. Release this feature under an env variable so people can enable it when they deploy their own Vercel instance (see feat: add CACHE_SECONDS environment variable #2266 and feat: enable multi page star fetching for private vercel instances #2159 for an example).

I'm curious to hear your thoughts on this matter. 👀

[vsoch]

I think it would take too many API calls with pagination to get that actual number, so my thinking is just to change the descriptor to describe what is actually being shown. E.g., instead of "Contributed to" something like "Contributed to since " or "Annual Contributions."

[rickstaa]

I think it would take too many API calls with pagination to get that actual number, so my thinking is just to change the descriptor to describe what is actually being shown. E.g., instead of "Contributed to" something like "Contributed to since " or "Annual Contributions."

I double-checked my conclusion above, and it looks like the contributionsCollection.totalRepositoriesWithContributedCommits also includes a user's own repositories. It, therefore, is no option for retrieving the stats we want. I updated community/community#39589 to reflect this. Hopefully, GitHub will improve its GraphQL API, and we can show all repositories a user has contributed to for the private Vercel instance and the upcoming GitHub action. I agree that pagination for the Public instance will take too many requests and, therefore, will force the rate limits to be reached.

For now, I created #2274 to prevent confusion from happening

Old card

[![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)

New card

[![Anurag's GitHub stats](https://github-readme-stats-git-fixrepo-7dd470-github-readme-stats-team.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)

Let me know what you think. 🤔

[vsoch]

I think that's exactly what I had a mind, and a good solution until the API query can be figured out! 👍

[rickstaa]

@vsoch Since your bug report highlighted a major error in the stats card, I merged #2274 without a review of @anuraghazra. It could be that @anuraghazra decides to revert this change, but I think it is justified. I created #2282 to track the accompanying feature request further. Hopefully, GitHub will update its API so that we can also show the total time contributed to stats.

[rickstaa]

I just added #2283 to fix a small bug introduced in #2274.

[vsoch]

Fantastic! It's showing up in my profile - and I know it's not perfect, but it's so much more clear! So I think it's a good change until there is an accurate count for total repos (I am not sure I want to know, haha) 😆