GitHub는 오픈소스 개발자들이 모여 협업하는 플랫폼으로, 사용자들은 자신의 기여도를 파악하고 다른 개발자와 연결되는 데 많은 관심을 가집니다. 하지만 기존의 GitHub 통계는 개인의 기여도를 정확히 반영하지 못하는 경우가 많습니다. 이런 문제를 해결하기 위해 등장한 프로젝트가 바로 jstrieb/github-stats입니다. 이 프로젝트는 개인의 GitHub 프로필에 대한 통계 정보를 시각적으로 표현하여, 사용자가 자신의 기여도를 보다 명확하게 보여줄 수 있도록 돕습니다.

🚀 주요 기능과 특징

이 프로젝트의 핵심 기능은 다음과 같습니다:

  1. 개인 및 비공개 레포지토리 통계 지원: 개인 레포지토리와, 사용자가 기여한 레포지토리의 통계도 포함하여 시각적으로 표현합니다. 이는 사용자가 더 많은 기여를 하고 있다는 것을 효과적으로 보여줍니다.
  2. 자동 이미지 생성: GitHub Actions를 활용하여 통계 이미지를 자동으로 생성합니다. 이 과정은 서버가 필요 없으며, 사용자가 직접 GitHub Actions를 실행하여 최신 통계를 반영한 이미지를 얻을 수 있습니다.
  3. 다양한 시각화 옵션: 생성된 이미지는 GitHub의 라이트 모드와 다크 모드에 자동으로 적응하여, 프로필이나 README에 넣었을 때 항상 최적의 보기 환경을 제공합니다.
  4. JSON 데이터 출력: 모든 통계를 JSON 파일로 출력하여, 추가적인 데이터 분석을 할 수 있는 기능도 제공합니다.

    5. 📦 설치 및 기본 사용법

    이제 github-stats를 설치하고 사용하는 방법을 알아보겠습니다. 이 프로젝트는 GitHub Actions를 사용하므로, 몇 가지 간단한 설정만 하면 됩니다.

    1. 레포지토리 포크하기

    먼저, 이 프로젝트를 자신이 사용할 수 있도록 포크합니다. GitHub에서 jstrieb/github-stats 페이지로 가서 "Fork" 버튼을 클릭하세요.

    2. GitHub Secrets 설정하기

    포크한 레포지토리로 가서, Settings 탭으로 들어갑니다. 왼쪽 사이드바에서 "Secrets and variables" > "Actions"를 선택하고, 다음 두 가지 비밀을 추가합니다:

    • GITHUB_TOKEN: 이 토큰은 GitHub에서 자동으로 제공됩니다. 사용자가 직접 입력할 필요는 없습니다.
    • ACCESS_TOKEN: 개인 레포지토리에 접근하기 위한 개인 액세스 토큰을 입력합니다.

      • 3. GitHub Actions 설정하기

      레포지토리의 .github/workflows 디렉토리에서 main.yml 파일을 설정합니다. 기본적으로 제공되는 템플릿을 사용하여 필요에 따라 수정할 수 있습니다.

      name: Generate Stats

on:
  schedule:
    - cron: '0 0   *' # 매일 자정에 실행
  workflow_dispatch: # 수동 실행도 가능

jobs:
  generate-stats:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2

      - name: Run GitHub Stats
        run: zig run src/main.zig

      4. 통계 이미지 생성하기

      이제 GitHub Actions를 수동으로 실행하거나, 설정한 대로 매일 자정 자동으로 실행되도록 할 수 있습니다. 실행이 완료되면, README.md 파일에 다음과 같은 코드를 추가하여 통계 이미지를 포함시킬 수 있습니다.

      Overview Stats
Languages Stats

      💼 실무에서의 활용 시나리오

      이 도구는 주로 GitHub 프로필을 보다 매력적으로 만들어 다른 개발자들이 내 기여도를 쉽게 이해하도록 돕는 데 유용합니다. 예를 들어, 오픈소스 프로젝트에 여러 기여를 한 개발자라면, README.md에 통계 이미지를 추가하여 자신의 기여도를 시각적으로 강조할 수 있습니다. 이로 인해 다른 개발자들이 자신의 작업을 더욱 신뢰하고, 협업을 요청할 가능성이 높아집니다.

      또한, 팀 단위로 오픈소스 프로젝트를 개발하는 경우, 각 팀원의 기여를 시각화하여 팀의 성과를 보여주는 데 사용할 수 있습니다. 이렇게 하면 팀 분위기를 더욱 고양하고, 동기부여가 될 수 있습니다.

      🔍 비슷한 도구와 비교

      비슷한 기능을 제공하는 도구로는 shields.io와 GitHub Readme Stats 등이 있습니다. 그러나 이들 도구는 비공식적인 기여를 통계에 포함하지 않는 경향이 있습니다. 반면 github-stats는 비공식적인 기여를 포함하여 보다 포괄적인 통계를 제공합니다.

      🏁 추천 대상

    • 오픈소스 프로젝트에 활발히 참여하는 개발자
    • 개인 프로필을 더욱 매력적으로 꾸미고 싶은 개발자
    • 팀의 기여도를 시각적으로 표현하고 싶은 팀 리더

이제 여러분도 jstrieb/github-stats를 활용하여 GitHub 통계를 시각화해보세요! 자세한 내용은 GitHub 레포지토리에서 확인할 수 있습니다: github-stats