Function useGitHubRank

  • useGitHubRank(
        user1: null | User,
        user2: null | User,
    ):
        | null
        | {
            scoreDiff: number;
            user1Score: number;
            user2Score: number;
            winner: number;
        }

  • Custom hook that calculates and compares GitHub user rankings

    Features:

    • Calculates individual scores for different metrics
    • Applies weights to each metric
    • Computes percentile scores
    • Determines winner in comparison

    Metrics Used:

    • Commit contributions
    • Pull requests
    • Issues
    • Code reviews
    • Repository stars
    • Followers

    Score Calculation:

    • Uses exponential CDF for activity metrics
    • Uses log-normal CDF for popularity metrics
    • Applies weighted averaging
    • Converts to percentile

    Parameters

    • user1: null | User

      First GitHub user data

    • user2: null | User

      Second GitHub user data

    Returns
        | null
        | {
            scoreDiff: number;
            user1Score: number;
            user2Score: number;
            winner: number;
        }

    Ranking results including scores and winner, or null if data missing

    Example

    const rankingResult = useGitHubRank(user1Data, user2Data);
    if (rankingResult) {
      console.log(`Winner: User ${rankingResult.winner}`);
    }

Settings

Member Visibility