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

Create an Offchain Profile/Contributor/Contribution System #10

Open
moul opened this issue Oct 18, 2023 · 4 comments
Open

Create an Offchain Profile/Contributor/Contribution System #10

moul opened this issue Oct 18, 2023 · 4 comments
Assignees

Comments

@moul
Copy link
Member

moul commented Oct 18, 2023

Overview:
I suggest creating a system to keep track of contributors and their contributions. It will blend automatic data and manual entries to give a full picture of who contributes and what they do.

Manual LinkedIn Profile:

Automated GitHub Contributions:

  • We'll build a GitHub bot to create contributors/$pr-author/gh-contributions.md.
  • This file will fill up with info about "merged PRs" and relevant data.
  • No scores here; just facts. We'll later use an oracle to put this on the blockchain.

Notable Contributions:

Aggregates:

  • We'll create summaries based on individuals (contributors/$name/README.md) or projects (root/README.md).
  • These summaries will show who did what and what happened recently on the projects.
  • In the future, we'll make this automatic on the blockchain. But for now, we'll use scripts and CI.

Goal:

  • We'll start with off-chain activities, using both manual and bot help.
  • In the long run, we'll move most of this to the blockchain with voting systems.
  • If we keep this repo, we'll make sure data syncs safely with an oracle.

Note: Share your thoughts on this issue. Your feedback matters.

@moul
Copy link
Member Author

moul commented Oct 26, 2023

See #11 for a v0

@moul
Copy link
Member Author

moul commented Nov 9, 2023

Once we have obtained the GitHub contribution list for a profile, let's proceed with generating some reports. These reports will include:

  • Weekly Changelog: This report will highlight the recently merged items.
  • Hot Topics: This report will list the active issues and pull requests, sorted by the number of new comments they have received.
  • ...

@moul
Copy link
Member Author

moul commented Nov 9, 2023

To complete the process, follow these steps:

  1. Link the scripts from the repository, specifically contributors/<name>/github-contributions.csv.
  2. Update the profile generator (feat: add scripts/update-contributors-readme.sh script + run it #11) to include the sourced data in the generated profile, presented in markdown format for readability.
  3. Explore the possibility of generating additional reports using the newly sourced data.
  4. Finally, attempt to push the data onto the blockchain once you have gained some experience using it. This will help ensure the stability of the data structure.

@waymobetta
Copy link
Contributor

Adding myself for visibility into conversation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🙏🏻 To Delegate
Status: No status
Development

No branches or pull requests

4 participants