GitHub Contribution Period Analysis
Core Goal
- Build an evidence-based Markdown report for one target GitHub user in a UTC time window.
- Focus on practical code contribution signals: merged PR and commit activity.
- Cover both own repositories and other repositories, limited by credential access.
Workflow
- Prepare authentication for GitHub API access.
- Run
scripts/github_contribution_report.pywith target user and time window. - Review the generated Markdown report and inspect evidence links.
Command
python3 scripts/github_contribution_report.py \
--user <github-login> \
--start 2026-03-01 \
--end 2026-03-08 \
--output /tmp/github-contribution-report.mdOutput Semantics
- Included contribution types:
- Authored merged PRs. - PRs merged by the target user (maintainer merge work). - Authored commits.
- Excluded activity types:
- Comments, reviews, stars, watches, forks.
- The report contains:
- Scope and coverage notes. - Summary metrics. - Substantive work categories inferred from PR/commit evidence. - Work content highlights with representative evidence links. - Repository breakdown. - Per-repository concrete change details (for every changed repository). - Contribution timeline. - Top contribution tables. - Evidence appendix with PR/commit URLs.
Important Constraints
- SSH key alone is for
gittransport and does not directly authorize GitHub REST API calls. - Private repository coverage needs authenticated API access, typically via
GITHUB_TOKEN/GH_TOKENorgh auth token. - GitHub Search API has a 1000-item cap per query. For very active users, split the time range and run multiple reports.
References
references/env.mdreferences/data-model.mdreferences/markdown-template.md
Scripts
scripts/github_contribution_report.py