Skip to content

Add contributor recognition docs#89

Merged
SaharPak merged 4 commits into
mainfrom
docs/contributor-recognition
Jul 2, 2026
Merged

Add contributor recognition docs#89
SaharPak merged 4 commits into
mainfrom
docs/contributor-recognition

Conversation

@SaharPak

@SaharPak SaharPak commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a respectful, community-friendly contributor recognition system to the
repo. Two new docs files plus a small README section. Designed to feel like
a thank-you, not a leaderboard — counts are presented as a snapshot,
not a ranking.

How contributors were identified

Pulled together four data sources and cross-checked them:

  1. gh pr list --state merged --limit 100 — 28 merged PRs by 10 distinct
    authors.
  2. gh pr list --state closed --limit 200 filtered to non-merged — 4
    PRs by 4 distinct authors. Each is documented with the reason it was
    closed (rule already present, supersession, etc.).
  3. git shortlog -sn against main — for the raw commit / author
    table including anonymous contributors.
  4. gh api repos/TechImmigrants/cv-builder/contributors?anon=true
    GitHub's view, which only counts commits on the default branch by
    public GitHub account.

Open PRs (#37 by riddhij-7, #78 by Isusami, #89 — this PR — by
SaharPak) were intentionally left out of the merged count; the two
external contributors are listed by name in the new docs.

What changed

  • New: docs/CONTRIBUTORS.md — human-first recognition. Sections:
    Maintainers, Code contributors (Foundation stack, Web UI, Rules,
    Archetypes, CLI, Infrastructure), Docs and roadmap contributors,
    Testing / QA contributors, Product and community feedback contributors,
    Special thanks, Attribution caveats, How to add yourself.
  • New: docs/CONTRIBUTION_SNAPSHOT.md — the numbers. Date, totals,
    top contributors by merged-PR count (amirbahador-hub 9,
    SaharPak 8, heerrpanchal 3, alexNJF 2, plus six 1-of-1
    contributors), git shortlog-vs-API comparison, notable contribution
    areas, and a refresh recipe.
  • Updated: README.md — added a small Contributors section
    between Community and Research, linking to both new docs and to
    the GitHub contributors graph.

Caveats about contribution counts

This snapshot is honest about what we can and can't measure:

  • Counts disagree between git shortlog and the GitHub contributors
    API (the API counts only commits on the default branch and merges
    author names by GitHub account).
  • PR count and commit count are imperfect proxies for effort. A 5-line
    rule PR and a 500-line foundation PR both count as one. Bulk
    reformatting and one careful bug fix both count as one commit.
  • a.hakimi (13 commits on main) authored meaningful dark-mode and
    CV/JD input work that landed through alexNJF's PRs feat(web): add dark/light mode toggle with Tailwind CSS v4 #58 and Add CV and JD input screen with file upload and client-side evaluation #76,
    but their commits don't link to a public GitHub account from the
    local git author metadata. The work is real; the attribution is
    noisy. CONTRIBUTORS.md calls this out and asks them to open an
    issue so we can add a real profile link.
  • Cleanup Bot is a local git author name used during the post-PR Integrate CV Builder MVP foundation and close PR cleanup pass #85
    integration pass; not a real contributor and excluded from
    recognition. Documented in the snapshot caveats.
  • Issue-only contributors are not in the counts yet. The issue tracker
    is a major contribution surface; CONTRIBUTORS.md already calls it
    out as the largest under-counted surface, and CONTRIBUTION_SNAPSHOT.md
    notes that we'll add a per-issue section as community testing begins.
  • The 4 closed-not-merged PRs and 3 open PRs are listed explicitly in
    CONTRIBUTION_SNAPSHOT.md so it's clear nobody has been excluded.

Validation results

  • pnpm test12/12 successful (cached; docs-only change).
  • pnpm lintNo new findings. One pre-existing Biome migration
    info note on biome.json (linter block under formatter)
    is unchanged from main.
  • pnpm build6/6 successful (cached).

PR #37 and #78 — not touched

Both contributors are listed by name in docs/CONTRIBUTORS.md so
their work is recognized regardless of merge status.

Summary by CodeRabbit

  • Documentation
    • Added a new “Contributors” section to the README with links to contributor recognition, the live contributors graph, and a refreshed contribution snapshot.
    • Published a Contribution Snapshot document with activity metrics, contributor breakdowns, notable contribution areas, caveats, and refresh instructions.
    • Expanded the Contributors page to provide community recognition across maintainers, code, docs, QA, and feedback, including attribution caveats and a workflow to add/update contributors.

@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 45d5722b-34a5-494a-8975-edf8de840fd0

📥 Commits

Reviewing files that changed from the base of the PR and between bda5be8 and ca88c01.

📒 Files selected for processing (3)
  • README.md
  • docs/CONTRIBUTION_SNAPSHOT.md
  • docs/CONTRIBUTORS.md
✅ Files skipped from review due to trivial changes (2)
  • docs/CONTRIBUTION_SNAPSHOT.md
  • docs/CONTRIBUTORS.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

📝 Walkthrough

Walkthrough

This PR adds contributor recognition documentation: a new README section linking to two new docs, a contribution snapshot with PR and commit statistics, and a contributors page organizing attribution, caveats, and contribution instructions.

Changes

Contributor Recognition Documentation

Layer / File(s) Summary
README Contributors section
README.md
Adds a "Contributors" section with links to the contributors page, contribution snapshot, and GitHub contributors graph, plus guidance for missing names.
Contribution snapshot document
docs/CONTRIBUTION_SNAPSHOT.md
Adds a new document with snapshot metadata, merged/closed/open PR aggregation, commit breakdowns, anonymous commit listing, notable contribution areas, caveats, and refresh instructions.
Contributors recognition page
docs/CONTRIBUTORS.md
Adds a new document organizing maintainers, code contributors by area, docs/QA/product contributors, special thanks, attribution caveats, and a "how to add yourself" workflow.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding contributor recognition documentation and related README links.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/contributor-recognition

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/CONTRIBUTION_SNAPSHOT.md`:
- Around line 75-97: The contributor snapshot is using git shortlog over all
refs, which can pull in branch-only commits and distort the main-branch counts.
Update the `git shortlog -sn --all` reference in `docs/CONTRIBUTION_SNAPSHOT.md`
to use `main` instead, so this table reflects only commits on the main branch
and stays consistent with the rest of the snapshot.

In `@docs/CONTRIBUTORS.md`:
- Around line 76-80: The CONTRIBUTORS entry mentions `pnpm format`, but the
documented workflow uses the repo’s actual formatting command. Update the
contributor note in this section to reference `biome format --write .` instead,
keeping the rest of the attribution text unchanged. Use the `CONTRIBUTORS.md`
entry around the `davido-noowin` bullet as the anchor when editing.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 41f613dd-a107-43f7-94f0-5b5435b8a1ae

📥 Commits

Reviewing files that changed from the base of the PR and between 4e43a3c and bda5be8.

📒 Files selected for processing (3)
  • README.md
  • docs/CONTRIBUTION_SNAPSHOT.md
  • docs/CONTRIBUTORS.md

Comment thread docs/CONTRIBUTION_SNAPSHOT.md
Comment thread docs/CONTRIBUTORS.md
Cleanup Bot added 3 commits July 2, 2026 22:10
- Fix distinct merged-PR author count: 9 -> 10 (verified via gh pr list)
- Add Cleanup Bot to the Anonymous commits on main table (22 commits)
- Add explicit caveat: counts do not capture review, discussion,
  product thinking, or community support
- Remove private email a.hakimi@mohaymen.ir from caveat 4
- Remove fabricated github.com/a.hakimi link (returns 404)
- Soften 'not a real contributor' to 'not a human contributor'
- Rename 'Top contributors by merged-PR count' to 'Contributors by
  merged-PR count' to reduce ranking feel
- Update snapshot commit hash: 4e43a3c -> 4b4bb03 (post-#88 + #92)
- Total merged PRs: 26 -> 28 (#88 and #92 both merged by SaharPak)
- Distinct merged-PR authors: 10 (unchanged)
- SaharPak merged-PR count: 6 -> 8
- Open PRs: remove #88 (now merged), add #89 (this PR)
- Notable contribution areas: add 'Docs consistency audit' and 'Archetype gap audit'
- Privacy: drop private-email field from anonymous-contributor refresh recipe
- Last refreshed footer: note PR #88 and PR #92
- Maintainers + Docs sections: credit PR #92 archetype gap audit
- Archetype count: 8 -> 7 in IKetutWidiyane and Mohammadreza-Sarvari sections
@SaharPak SaharPak force-pushed the docs/contributor-recognition branch from 6b22a8c to 818ae6f Compare July 2, 2026 19:13
@SaharPak SaharPak merged commit 44b475c into main Jul 2, 2026
3 checks 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