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

Dynamic GitHub Contributors #348

Open
3 tasks
proletesseract opened this issue Dec 2, 2021 · 0 comments · May be fixed by #352
Open
3 tasks

Dynamic GitHub Contributors #348

proletesseract opened this issue Dec 2, 2021 · 0 comments · May be fixed by #352
Assignees

Comments

@proletesseract
Copy link
Member

proletesseract commented Dec 2, 2021

Description

Dynamically display the contributors to various navcoin related repositories on the navcoin-org website.

Repos to include;

https://github.com/navcoin/navcoin-core
https://github.com/navcoin/navcoin-org
https://github.com/sakdeniz/next
https://github.com/sakdeniz/next-mobile
https://github.com/navcoin/KnowledgeBase

(more tbc)

Recommendations

The contributors for a repo can be dynamically pulled from the GitHub API as shown here: https://github.com/navcoin/navcoin-core/graphs/contributors

The dynamic content can be loaded by a react app which operates like a javascript widget that loads into a div on the page. There is an example of how to do this on the old navcoin-org site which pulled in the github project cards to the roadmap page.

https://github.com/navcoin/navcoin-org/tree/204-github-roadmap/react/components

From a design perspective i would just make it looks something like the insights part of github, but using the new design elements of the website. Otherwise, it is open to your judgement how to make it look good, perhaps discuss it with anquii. it would great to see at least the username, profile pic, number of commits etc. and since it is aggregating multiple repos, there should be labels on each user showing which repositories they are contributing to.

One thing which we will probably want to add in the future is some way to display users who are not coders (e.g. discord heroes, content contributors) on this page. But this should be done in a dynamic way which does not require a manual list to be maintained. For example perhaps we look at NavCoin Collective on medium and pull all the authors and the number of articles they have each written for the publication. This is not a requirement for this ticket, but it is something to keep in mind while designing the react app.

Where on the site this goes is up to you. Perhaps talk with anquii about it.

If you can architect this in a way which is reasonably easy to repurpose with other APIs then that would be ideal. There are a few other areas which we could include these widgets throughout the site to make some of the content dynamic from various sources.

Acceptance Criteria

  • Description is satisfied
  • Changes display correctly on desktop / mobile
  • Translations have been added or amended as necessary
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants