FOSS.NG OSS LEADERBOARD

Overview

We are building a leaderboard for open-source contributions of UC students. The primary goal is to encourage students to make open-source contributions, improving their github profile, and developing software collaboration skills.

Key Features

1. Sign-up: A student can sign up using their Github Account and UC email
2. Scoring and Ranking: Periodically, the program scrapes their OSS contributions, and scores and ranks them
3. Leaderboard: Everyone can view the leaderboard with top contributors and their contributions
4. User Profile: A page with detailed information on each contributor, the projects they contributed to, proficient languages, interests etc.

Track your contributions

We track the github projects listed in the projects.txt file. To add your project and contributions, create a PR with the URL of each project in a new line. NOTE: We only track public repositories

Other considerations

1. Scoring Algorithm: The score assigned to each contribution should be factor in the popularity, usefulness of the project. It should use indicators like stars, fork, # of contributors, age of commit, issues, PR reviews etc.

Technical specifications

1. Database: Postgres via Tembo.
2. UI: Evidence.dev
3. Domain: TBD
4. Hosting: Evidence Cloud

Architecture

graph LR;  
    subgraph Postgres
        A[Data] --> B[Processing]
        B --> A 
    end;

    subgraph GitHub
        G1[Migrations]
        G2[Markdown]
        G3[Projects]
    end;

    A -.-> D[Evidence.dev]
    G2 -.-> D
    D --> E[Website];

    F[Users] --> A;
    E -->|Signup| F;
    F --> |PR| G3;
    G1 --> A;
    G3 --> A;

Loading

Schema Overview

• Users: These will be the UC students and contributors we will be tracking. Stores information like their email, github username, major, year, score
• Projects: Projects that students contributed to. This should be automatically scraped. It stores information like stars, contributors, forks etc
• Contributions: Links the users to project commits
• Leaderboard history: Optional

Future Enhancements

1. Expand to other universities
2. Screener for employers to find the student who is the right fit for the role
3. Track contributions across other VCS, research publications etc.