Skip to content
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

Surface Github contritbutors #2103

Open
3 tasks
Betree opened this issue Jun 6, 2019 · 11 comments
Open
3 tasks

Surface Github contritbutors #2103

Betree opened this issue Jun 6, 2019 · 11 comments
Labels
api Issues that require some work on the API (https://github.com/opencollective/opencollective-api) complexity → medium feature frontend stale

Comments

@Betree
Copy link
Member

Betree commented Jun 6, 2019

Motivation

In the new tier/collective pages, we want to add a Github Contributors filter:

image

MVP

Long term solution

At some point we may want to store more info on the Github contributors when fetching them in https://github.com/opencollective/opencollective-api/blob/c4eec669f0633cccedc56173c223e927a1da81d2/cron/daily/update-contributions.js#L106:

  • The name
  • The picture (store it internally rather than directly using Github's URL)

The proper place for that would be in a separate table, not in collective's data

@Betree Betree added feature complexity → complex api Issues that require some work on the API (https://github.com/opencollective/opencollective-api) frontend labels Jun 6, 2019
@Betree Betree added this to To do in Collective page via automation Jun 6, 2019
@Betree Betree moved this from To do to Backlog in Collective page Jun 6, 2019
@alanna
Copy link
Contributor

alanna commented Jun 9, 2019

@Betree what is the motivation/purpose of this feature? Who is asking for it? Who have we tested it with? I'm just surprised this is being prioritized as I've not heard it requested through support or through Open Source Collective channels.

@Betree
Copy link
Member Author

Betree commented Jun 9, 2019

It's part of the design for the new collective page, the motivation is to surface any type of contributors (not only financial) on the contributors grid that is already implemented:

image

I'm not sure who proposed this initially, I'm just the one in charge to see how we can make it happen 🙂 The purpose and prioritization is a discussion to have with the rest of the team and design. @cuiki any pointer about this?

On my side this task is in backlog, not TODO, which mean I'm not planning to work on it for the initial release of the new collective page.

Copy link
Contributor

@alanna this was part of the initial design of open collective and we removed it because it was too heavy. Collectives liked it. It's a way of showing the whole community behind a collective not just the admin or the core team.

@alanna
Copy link
Contributor

alanna commented Jun 10, 2019

OK that makes sense @piamancini @Betree. I agree it would be nice to have.

My thought process was like this....

  • Oh, this will mainly benefit OSC Collectives, maybe this should be paid from that budget
  • Hmmm considering the OSC's limited budget, I don't think this is the priority right now

If it's more of a backlog item, that's fine. I hope we have it someday; there are just other more urgent things now.

Copy link
Contributor

@Betree are we putting this on the list for up coming versions? We have the design of the cards that for code contributors.

@stale stale bot removed the stale label Sep 13, 2019
@Betree
Copy link
Member Author

Betree commented Sep 13, 2019

@piamancini It's in the backlog, I have no ETA for this one at the moment. It will have to be a project of its own, but that may be a good candidate for a bounty. I'll assign myself for now so I can do more research and write more precise specs.

@Betree Betree self-assigned this Sep 13, 2019
Copy link
Contributor

great thanks - we used to have this in the past so lmk when you are ready and I can help with how we used to do it, how we changed and then dropped it

@opencollective opencollective deleted a comment from stale bot Sep 14, 2019
@alanna alanna added the hackathon candidates for internal team hackathon label Sep 18, 2019
@znarf znarf removed the hackathon candidates for internal team hackathon label Sep 30, 2019
@jeffin143
Copy link
Member

In collective's contributors resolver, get the contributors usernames from collective.data.githubContributors and use that to build a list of ContributorType to be merged with the existing list.

@Betree could you point me to the contributors resolver, if you are ok with MVP as of now I can take up this, or else if you like to go with Long term solution once for all, and not first with MVP and then ultimately long term, Will be fine with that too :)

@Betree
Copy link
Member Author

Betree commented Oct 22, 2019

@jeffin143 Queries for this data are all in https://github.com/opencollective/opencollective-api/blob/a9a2a2ff7834e69349dffbaa3ceb91c3cc4421c2/server/lib/contributors.js

MVP would be fine for now. You're welcome to jump on it if you want to, however keep in mind that:

  • We may decide to delay the feature if we're not satisfied with the result (for example if there's a negative performance impact)
  • You'll have to dig into the data (you'll need something like DBeaver or PGAdmin) and in the code that fetches the data from Github. I can't provide a lot of help on that because I don't really know the code myself

@jeffin143
Copy link
Member

@Betree Thanks, I will take a look, but since you are also not aware of the code, it would be difficult to come up with something :)

Also I tried coming up with something but collective.data.githubContributors threw invalid property for the object, I should probably take a look into the data ( just like you said ).

@Betree Betree removed their assignment Nov 12, 2019
@stale
Copy link

stale bot commented Feb 10, 2020

This issue has been automatically marked as stale because it has not had recent activity. We want to keep it in our todo list but haven't had the time to address it yet.
Thank you for your contributions!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Issues that require some work on the API (https://github.com/opencollective/opencollective-api) complexity → medium feature frontend stale
Projects
Collective page
  
Backlog
Development

No branches or pull requests

5 participants