Dec 18

[IT/개발자/엔지니어링] Ready your Git: 코드 분석 및 리포트 생성 시스템

📌 프로젝트 소개

READ YOUR GIT은 Git 커밋 메시지를 분석하여 코드 변경 사항을 명확히 이해하고 문서화하는 문제를 해결하는 프로젝트입니다.
Empty space, drag to resize

🧐 문제 정의

현재 팀 및 개인 프로젝트의 중간·최종 보고는 대부분 commit log를 선별하고, 요약하고, 보고서 형식에 맞게 정리하는 반복적인 수작업으로 이루어져 있습니다. 이 과정에서 팀마다 보고 양식과 표현 방식이 달라 결과물의 일관성이 부족하고, 같은 기간의 진행 상황을 객관적으로 비교하기 어렵습니다.
특히 수십 개의 commit 중 어떤 변경 사항이 핵심인지 판단하기 위해 매번 로그를 직접 검토해야 하며, 이로 인해 다음과 같은 비효율이 발생합니다.

[문제]
- commit log 중 주요 변경 사항이나 bug fix 내역이 누락될 가능성이 높다.
- 중복된 내용이나 불필요한 commit 요약이 반복 작성된다.
- 보고서가 사람마다 다르게 작성되어 데이터 기반으로 진행률을 분석하거나 시각화하기 어렵다.
이러한 비효율은 단순히 보고 과정의 문제를 넘어, 팀 전체의 협업 투명성·기여도 평가·성과 관리에도 영향을 미칩니다.

즉, 프로젝트의 실제 개발 흐름을 객관적 데이터로 파악할 수 없다는 점이 READ YOUR GIT을 개발하게 된 직접적인 동기입니다.
Empty space, drag to resize

💡 문제 해결

READ YOUR GIT은 commit repository 데이터를 자동으로 수집·분석하여, 기존 수작업 중심의 보고 과정을 데이터 기반 자동화 프로세스로 대체합니다 Repository link 입력 한 번으로 GitHub API를 통해 commit·README·contributor 정보를 수집하고, commit message 내 기간별 활동 데이터를 구조화합니다. 이후 n8n workflow가 API 수집 → 집계 → 템플릿 바인딩 → PDF 생성을 오케스트레이션합니다.생성된 지표와 요약은 표준 HTML template에 바인딩되어 PDF로 출력되며, 이를 통해 팀 간 보고 형식의 불일치가 해소되고 관리자는 데이터 기반의 진행률·활동량 지표를 손쉽게 확보할 수 있습니다.
Empty space, drag to resize

⚙️ 핵심 기능

1. 자동 수집 및 정규화
   사용자가 GitHub Repository 링크를 한 번 입력하면 GitHub API에서 commit 로그, README, 참여자 정보를 자동으로 수집하고, 보고서 생성을 위한 공통 형식(기간·작성자·메시지·링크 등)으로 정규화합니다.

2. AI 기반 프로젝트 요약 섹션 생성(Upstage Solar Pro2 API 사용)
   수집된 README와 최근 커밋 내용을 Upstage Solar Pro2 LLM API에 전달해, 「프로젝트 한줄 요약 · 핵심 기능 · 설치/실행 요점 · 최근 변경점 하이라이트 · 향후 개선 아이디어」로 구성된 1번 섹션을 자동 작성합니다. 이를 통해 레포지토리의 전반적인 내용과 최신 변화를 바로 보고서 상단에서 파악할 수 있습니다.

3. 기간별 커밋 통계와 참여자 기여도 산출
   최근 24시간 / 7일 / 30일 기준으로 커밋 수, 참여자 수, 활동 시간대를 집계하여 표로 정리하고, 전체 커밋 대비 진행률(예: 약 40%)과 참여자별 커밋 수·최근 활동 시점·기여 비율을 계산해 막대 그래프로 시각화합니다.

4. README·커밋 로그 기반 상세 정보 정리
   README 본문을 그대로 포함한 「README 기반 프로젝트 정보」 섹션과, 최근 커밋 이력을 날짜·작성자·메시지·링크 형태로 정리한「부록. 전체 커밋 로그」를 자동 생성해, 별도의 추가 정리 없이도 프로젝트의 공식 설명과 상세 변경 이력을 하나의 표준 PDF 리포트로 바로 제출할 수 있도록 합니다.

Empty space, drag to resize

🎬 데모 영상

Write your awesome label here.
Empty space, drag to resize

👥 팀원 소개

김예린 - 워크플로우 전반, 프론트 연동
young01299@naver.com

송민경 - 아키텍처 및 Build HTML
smk051023@gmail.com 
안나 - 프론트엔드
nurdayana.aini3@gmail.com

안윤서 - 문서 및 ppt 제작, Build HTML
ahnyoonseo04@kangwon.ac.kr
Empty space, drag to resize

💾 참고 자료