Gamify repo - Add contributor leaderboard and points system #82

abdulanu0 · 2025-11-21T22:30:46Z

No description provided.

.github/workflows/auto-award-points.yml

.github/workflows/update-leaderboard.yml

Copilot

Pull request overview

This PR adds a comprehensive gamification system to incentivize repository contributions through a point-based leaderboard with badges, streaks, and multipliers. The system includes Python scripts for points management, automated GitHub Actions workflows for updates, and an embedded leaderboard display in the main README.

Key changes:

Point calculation engine with multipliers, bonuses, and streak tracking
SQLite database schema for contributors, contributions, and badges
Automated leaderboard updates via GitHub Actions running every 6 hours

Reviewed changes

Copilot reviewed 12 out of 13 changed files in this pull request and generated 27 comments.

Show a summary per file

File	Description
`gamification/python/points_service.py`	Core points calculation logic with priority multipliers, speed bonuses, and streak rewards
`gamification/python/database.py`	Database layer handling contributors, contributions, badges, and leaderboard queries
`gamification/python/manage_points.py`	Interactive CLI tool for maintainers to manually award points
`gamification/python/update_readme.py`	Script to generate and inject HTML leaderboard into main README
`gamification/python/generate_leaderboard_md.py`	Generates detailed leaderboard markdown file
`gamification/database/schema.sql`	SQLite schema defining tables, indexes, and seeding default actions/badges
`gamification/python/gamification.db`	Pre-populated SQLite database with sample data
`.github/workflows/update-leaderboard.yml`	Scheduled workflow to update leaderboard every 6 hours
`.github/workflows/auto-award-points.yml`	Event-driven workflow to auto-award points on PR merge and issue closure
`gamification/README.md`	Comprehensive documentation of the gamification system
`gamification/LEADERBOARD.md`	Generated leaderboard page with top contributors
`gamification/.gitignore`	Python and database-specific ignore patterns
`README.md`	Updated with embedded gamification leaderboard section

Copilot · 2025-11-21T22:37:48Z

.github/workflows/update-leaderboard.yml

+      - name: Update main README with leaderboard
+        run: |
+          cd gamification/python
+          python update_readme.py


Potential database file not found error. The workflow assumes gamification.db exists, but if this is the first run or the database doesn't exist, Python scripts may fail. Consider adding initialization logic or checking for database existence before running update scripts.

Copilot · 2025-11-21T22:37:49Z

.github/workflows/auto-award-points.yml

+      - name: Commit database changes
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add gamification/python/gamification.db
+          git diff --quiet && git diff --staged --quiet || git commit -m "chore: update gamification points [skip ci]"
+          git push
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}


Security risk: Committing database file directly. The workflow commits gamification.db directly to the repository, which can lead to merge conflicts and data inconsistencies when multiple workflows run concurrently. Consider using a database service or implementing proper locking mechanisms.

Suggested change

- name: Commit database changes

run: |

git config --local user.email "github-actions[bot]@users.noreply.github.com"

git config --local user.name "github-actions[bot]"

git add gamification/python/gamification.db

git diff --quiet && git diff --staged --quiet || git commit -m "chore: update gamification points [skip ci]"

git push

env:

GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

# (Removed the "Commit database changes" step to prevent committing and pushing the database file)

Copilot · 2025-11-21T22:37:49Z

gamification/database/schema.sql

+    id INTEGER PRIMARY KEY AUTOINCREMENT,
+    name VARCHAR(255) UNIQUE NOT NULL,
+    description TEXT,
+    tier VARCHAR(50) NOT NULL, -- Bronze, Silver, Gold, Platinum, Special


Misleading comment in database schema. The comment states "Bronze, Silver, Gold, Platinum, Special" for badge tiers, but there's no enforcement of these values in the database schema. Consider adding a CHECK constraint to ensure only valid tier values can be inserted.

Suggested change

tier VARCHAR(50) NOT NULL, -- Bronze, Silver, Gold, Platinum, Special

tier VARCHAR(50) NOT NULL CHECK (tier IN ('Bronze', 'Silver', 'Gold', 'Platinum', 'Special')), -- Bronze, Silver, Gold, Platinum, Special

Copilot · 2025-11-21T22:37:49Z

gamification/python/database.py

+        for badge in badges:
+            # Check if already awarded
+            cursor.execute(
+                "SELECT id FROM contributor_badges WHERE contributor_id = ? AND badge_id = ?",
+                (contributor_id, badge['id'])
+            )
+            if cursor.fetchone():
+                continue
+
+            # Check criteria
+            criteria = json.loads(badge['criteria']) if badge['criteria'] else {}
+
+            if self._check_badge_criteria(contributor, category_stats, criteria):
+                if self.award_badge(contributor_id, badge['id']):
+                    newly_awarded.append(badge)


N+1 query problem. For each badge being checked (lines 277-291), a separate query is executed to check if it's already awarded (lines 279-283). This results in N+1 database queries. Consider fetching all awarded badges for the contributor in a single query before the loop and checking membership in memory.

Copilot · 2025-11-21T22:37:50Z

gamification/python/update_readme.py

+    conn = sqlite3.connect(db_path)
+    cursor = conn.cursor()
+
+    # Get top 10 contributors
+    cursor.execute("""
+        SELECT 
+            c.github_username,
+            c.total_points,
+            c.current_streak,
+            COUNT(con.id) as contribution_count
+        FROM contributors c
+        LEFT JOIN contributions con ON c.id = con.contributor_id
+        GROUP BY c.github_username
+        ORDER BY c.total_points DESC
+        LIMIT 10
+    """)
+
+    rows = cursor.fetchall()
+    conn.close()
+


Missing error handling for database connection. If sqlite3.connect() fails, the connection won't be properly closed. Consider wrapping database operations in a try-finally block or using a context manager.

Suggested change

conn = sqlite3.connect(db_path)

cursor = conn.cursor()

# Get top 10 contributors

cursor.execute("""

SELECT

c.github_username,

c.total_points,

c.current_streak,

COUNT(con.id) as contribution_count

FROM contributors c

LEFT JOIN contributions con ON c.id = con.contributor_id

GROUP BY c.github_username

ORDER BY c.total_points DESC

LIMIT 10

""")

rows = cursor.fetchall()

conn.close()

with sqlite3.connect(db_path) as conn:

cursor = conn.cursor()

# Get top 10 contributors

cursor.execute("""

SELECT

c.github_username,

c.total_points,

c.current_streak,

COUNT(con.id) as contribution_count

FROM contributors c

LEFT JOIN contributions con ON c.id = con.contributor_id

GROUP BY c.github_username

ORDER BY c.total_points DESC

LIMIT 10

""")

rows = cursor.fetchall()

Copilot · 2025-11-21T22:37:55Z

gamification/python/manage_points.py

+        username,
+        'pr_merged',
+        {
+            'pr_number': int(pr_number),


Missing error handling for invalid input. If the user enters an invalid PR number (non-numeric), int(pr_number) will raise a ValueError. Wrap this in a try-except block to provide a user-friendly error message.

Copilot · 2025-11-21T22:37:55Z

gamification/python/points_service.py

+
+        # Check if this is a bug fix (higher points)
+        if pr_data.get('is_bug_fix'):
+            action = 'bug_fixed'


Variable action is not used.

Suggested change

action = 'bug_fixed'

Copilot · 2025-11-21T22:37:55Z

gamification/python/database.py

+
+import sqlite3
+import json
+from datetime import datetime, timedelta


Import of 'timedelta' is not used.

Suggested change

from datetime import datetime, timedelta

from datetime import datetime

Copilot · 2025-11-21T22:37:55Z

gamification/python/points_service.py

+Handles all logic for calculating points with multipliers, bonuses, and streaks.
+"""
+
+from datetime import datetime, timedelta


Import of 'timedelta' is not used.

Suggested change

from datetime import datetime, timedelta

from datetime import datetime

Copilot · 2025-11-21T22:37:56Z

gamification/python/update_readme.py

+"""
+
+import sqlite3
+import os


Import of 'os' is not used.

Suggested change

import os

gamification/python/database.py

.github/workflows/points.yml

LavanyaK235 · 2025-11-25T21:47:40Z

.github/workflows/points.yml

  pull_request_review:
    types: [submitted]
+  pull_request:
+    types: [closed]


can you also add this -

branches: [main] # Only award points for merges to main

LavanyaK235 · 2025-11-25T21:49:26Z

README.md

+<table>
+  <thead>
+    <tr>
+      <th align="center">🏆 Rank</th>


can you remove the test data?

may be use something like this -
🎉 Be the first contributor!

LavanyaK235 · 2025-11-25T21:51:52Z

README.md

+
+**[View full leaderboard and badges →](gamification/LEADERBOARD.md)**
+
+*Leaderboard updated every 6 hours by GitHub Actions. [Learn about our gamification system →](gamification/README.md)*


I don't think this is correct, this gets triggered whenever a certain action happens. for e.g., when someone closes a github pr in this repo.

could you confirm this and make the change?

LavanyaK235 · 2025-11-25T21:56:13Z

scripts/assign_points.py

+            pr_body = (pull_request.get('body') or '').lower()
+            if 'doc' in pr_title or 'readme' in pr_title or 'doc' in pr_body:
+                points += cfg['points']['documentation']
+                scoring_breakdown.append(f"documentation: +{cfg['points']['documentation']}")


this only checks the title and body and not the actual files, so if a pr's title is "documented bug" it gets the documentation changes related points, even though the files changed are not related to documentation. can you please modify this code to check the files?

LavanyaK235 · 2025-11-25T21:58:50Z

scripts/config_points.yml

+  issue_resolved: 1            # Points for closing an issue
+  documentation: 3             # Points for documentation improvements (README, docs/ folder)
+  security_fix: 8              # Points for security-related fixes
+  code_contribution: 2         # Points for general code contributions


do we have implementation for the code_contribution? I'm unable to find it

LavanyaK235 · 2025-11-25T22:03:02Z

scripts/assign_points.py

+            scoring_breakdown.append(f"security_fix: +{cfg['points']['security_fix']}")
+
+    # Check for issue closed event
+    elif action == "closed" and issue and not pull_request:


let's check if there is a way to award only if the state_reason=="completed". Otherwise the points will be awarded if I open an issue and close it without any reason.

…verify issue state_reason, remove test data and unimplemented code_contribution

LavanyaK235 · 2025-11-26T21:39:31Z

scripts/assign_points.py

+
+        # Check for documentation changes by examining files changed
+        # We need to make an API call to get the list of files
+        import requests


this is already imported at the beginning, can we remove it?

LavanyaK235 · 2025-11-26T21:40:20Z

scripts/assign_points.py

+        # Check for documentation changes by examining files changed
+        # We need to make an API call to get the list of files
+        import requests
+        repo = os.getenv('GITHUB_REPOSITORY')


you might have to "import os" at the beginning. Can you try to create some tests locally and run these changes to see if they work? copilot can create tests

LavanyaK235 · 2025-11-26T21:42:29Z

scripts/assign_points.py

+
+        # Check for security fixes (labels or keywords)
+        labels = [label.get('name', '').lower() for label in pull_request.get('labels', [])]
+        if 'security' in labels or any('security' in label for label in labels):


can we make this change - if any('security' in label for label in labels)

…ity label check

LavanyaK235 · 2025-12-02T17:29:54Z

.github/workflows/points.yml

    if: >
      github.event_name == 'pull_request_review' ||
+      (github.event_name == 'pull_request' && github.event.pull_request.merged == true) ||
+      github.event_name == 'issues' ||


here we might have to check if the issue is closed. Can you check the documentation and see if we have to change it from "github.event_name == 'issues'" to "github.event_name == 'issues' && github.event.action == 'closed'"

Gamify repo - Add contributor leaderboard and points system

255e6d4

Copilot AI review requested due to automatic review settings November 21, 2025 22:30

abdulanu0 requested a review from a team as a code owner November 21, 2025 22:30

Copilot started reviewing on behalf of abdulanu0 November 21, 2025 22:31 View session

github-advanced-security bot found potential problems Nov 21, 2025

View reviewed changes

.github/workflows/auto-award-points.yml Fixed Show fixed Hide fixed

.github/workflows/update-leaderboard.yml Fixed Show fixed Hide fixed

Copilot finished reviewing on behalf of abdulanu0 November 21, 2025 22:34

Copilot AI reviewed Nov 21, 2025

View reviewed changes

rahuldevikar761 reviewed Nov 24, 2025

View reviewed changes

gamification/python/database.py Outdated Show resolved Hide resolved

Followed the pattern for the gamification

fab0492

LavanyaK235 reviewed Nov 25, 2025

View reviewed changes

.github/workflows/points.yml Show resolved Hide resolved

Resolving comments

5ec0ea6

LavanyaK235 reviewed Nov 26, 2025

View reviewed changes

Address PR review comments: add branch filter, check files for docs, …

bb64b7a

…verify issue state_reason, remove test data and unimplemented code_contribution

LavanyaK235 reviewed Nov 26, 2025

View reviewed changes

Address code review comments: remove duplicate import, simplify secur…

95b7da8

…ity label check

LavanyaK235 reviewed Dec 2, 2025

View reviewed changes

	tier VARCHAR(50) NOT NULL, -- Bronze, Silver, Gold, Platinum, Special
	tier VARCHAR(50) NOT NULL CHECK (tier IN ('Bronze', 'Silver', 'Gold', 'Platinum', 'Special')), -- Bronze, Silver, Gold, Platinum, Special

	from datetime import datetime, timedelta
	from datetime import datetime


		[View full leaderboard and badges →](gamification/LEADERBOARD.md)

		Leaderboard updated every 6 hours by GitHub Actions. [Learn about our gamification system →](gamification/README.md)

Gamify repo - Add contributor leaderboard and points system #82

Are you sure you want to change the base?

Gamify repo - Add contributor leaderboard and points system #82

Uh oh!

Conversation

abdulanu0 commented Nov 21, 2025

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants