Skip to content

Optimization: 5/5 GitHub Portfolio Rating — Visibility, Community Health, SEO, and Social Proof - #13

Merged
thedatavigilante merged 10 commits into
mainfrom
optimization-5-to-5
Jun 28, 2026
Merged

Optimization: 5/5 GitHub Portfolio Rating — Visibility, Community Health, SEO, and Social Proof#13
thedatavigilante merged 10 commits into
mainfrom
optimization-5-to-5

Conversation

@thedatavigilante

Copy link
Copy Markdown
Owner

🎯 Goal

Elevate the UI_INDEX repository from a 4/5 to a 5/5 GitHub portfolio rating by implementing best practices across visibility, community health, technical SEO, and social proof.

✅ Changes Made

Phase 1: Visibility

  • Dynamic shields.io badges — stars, forks, last commit, CI status, license, live site link
  • 6-second scannable block — who it's for, what it does, why it matters
  • Table of Contents with anchor links

Phase 2: Community Health (13 new files)

  • CODE_OF_CONDUCT.md — Contributor Covenant standard
  • SECURITY.md — vulnerability reporting process
  • SUPPORT.md — support channels and expectations
  • .github/ISSUE_TEMPLATE/ — bug report, data correction, feature request (YAML forms)
  • .github/PULL_REQUEST_TEMPLATE.md — structured PR template
  • .github/config.yml — issue routing and support links
  • .github/dependabot.yml — automated dependency updates
  • CITATION.cff — academic citation metadata
  • CHANGELOG.md — version history and migration notes
  • .zenodo.json — DOI-ready archive metadata
  • .mailmap — git identity normalization

Phase 3: Content Polish

  • Added CITATION.cff and CHANGELOG.md
  • Table of Contents with GitHub-native anchor links

Phase 4: Technical SEO

  • JSON-LD structured data (Dataset schema.org type) on all 4 HTML pages
  • Complete Open Graph tagsog:title, og:description, og:type, og:url, og:image, og:image:width, og:image:height
  • Complete Twitter Card tagstwitter:card, twitter:title, twitter:description, twitter:image
  • Added spatialCoverage, temporalCoverage, and keywords to JSON-LD

Phase 5: Social Proof

  • Created thedatavigilante/thedatavigilante Profile README repo

📋 Manual Steps Required (Post-Merge)

The following steps cannot be automated via API and require manual action via the GitHub web UI:

  1. Repository topics/tags — Go to the repo homepage → click the gear icon next to "About" → add:

    • unemployment-insurance
    • forensic-audit
    • data-visualization
    • campaign-finance
    • public-policy
    • dmv
    • bls-data
    • fec-api
  2. Social preview image — Settings → Social preview → Upload a custom image (e.g., figures/01_bai_decay_trajectory.png)

  3. Profile README — The thedatavigilante/thedatavigilante repo is already created; pin it to your profile via GitHub settings

🔗 References


Ready for review and merge. All automated checks (validate.yml) should pass as no existing code was modified — only documentation, metadata, and HTML meta tags were added.

…pendabot, CITATION.cff, CHANGELOG, .zenodo.json, .mailmap

Adds all missing community health and metadata files per 5/5 repo standards:
- CODE_OF_CONDUCT.md (Contributor Covenant v2.1)
- SECURITY.md (vulnerability reporting + data integrity policy)
- SUPPORT.md (routing for data corrections, press, reuse)
- CITATION.cff (machine-readable software citation)
- CHANGELOG.md (Keep a Changelog format, semantic versioning)
- .zenodo.json (ready for one-click DOI generation)
- .mailmap (resolves 4 conflicting git committer identities)
- .github/dependabot.yml (weekly pip dependency scanning)
- .github/ISSUE_TEMPLATE/bug_report.yml
- .github/ISSUE_TEMPLATE/data_correction.yml
- .github/ISSUE_TEMPLATE/feature_request.yml
- .github/PULL_REQUEST_TEMPLATE.md
- .github/config.yml

Part of the UI_INDEX 4→5 optimization roadmap.
…pts → $62.9M self-loans) to match $27.0M math
…g % (97.7% → 98.6%) across index.html and political.html
…PIs, integration architecture, governance notes)
…counts to 5 indices/13 figures/5 FEC charts/6 notebooks
@thedatavigilante
thedatavigilante merged commit c02530e into main Jun 28, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant