Add contributor recognition docs#89
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
✅ Files skipped from review due to trivial changes (2)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThis 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. ChangesContributor Recognition Documentation
Estimated code review effort: 2 (Simple) | ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (3)
README.mddocs/CONTRIBUTION_SNAPSHOT.mddocs/CONTRIBUTORS.md
- 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
6b22a8c to
818ae6f
Compare
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:
gh pr list --state merged --limit 100— 28 merged PRs by 10 distinctauthors.
gh pr list --state closed --limit 200filtered to non-merged — 4PRs by 4 distinct authors. Each is documented with the reason it was
closed (rule already present, supersession, etc.).
git shortlog -snagainstmain— for the raw commit / authortable including anonymous contributors.
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 byIsusami, #89 — this PR — bySaharPak) were intentionally left out of the merged count; the twoexternal contributors are listed by name in the new docs.
What changed
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.
docs/CONTRIBUTION_SNAPSHOT.md— the numbers. Date, totals,top contributors by merged-PR count (
amirbahador-hub9,SaharPak8,heerrpanchal3,alexNJF2, plus six 1-of-1contributors),
git shortlog-vs-API comparison, notable contributionareas, and a refresh recipe.
README.md— added a small Contributors sectionbetween 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:
git shortlogand the GitHub contributorsAPI (the API counts only commits on the default branch and merges
author names by GitHub account).
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 onmain) authored meaningful dark-mode andCV/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.mdcalls this out and asks them to open anissue so we can add a real profile link.
Cleanup Botis a local git author name used during the post-PR Integrate CV Builder MVP foundation and close PR cleanup pass #85integration pass; not a real contributor and excluded from
recognition. Documented in the snapshot caveats.
is a major contribution surface;
CONTRIBUTORS.mdalready calls itout as the largest under-counted surface, and
CONTRIBUTION_SNAPSHOT.mdnotes that we'll add a per-issue section as community testing begins.
CONTRIBUTION_SNAPSHOT.mdso it's clear nobody has been excluded.Validation results
pnpm test— 12/12 successful (cached; docs-only change).pnpm lint— No new findings. One pre-existing Biome migrationinfonote onbiome.json(linterblock underformatter)is unchanged from
main.pnpm build— 6/6 successful (cached).PR #37 and #78 — not touched
riddhij-7's PR feat(cli): add color output for scores, dimensions, and issues #37 (CLI color output) — not touched. The CLIwas refactored after the PR opened; it still needs an author rebase
before it can land.
Isusami's PR ci(web-ui): Cloudflare Pages preview deploys + setup docs #78 (Cloudflare Pages previews) — not touched.The project does not yet have a hosted deployment or the secrets it
needs (
CLOUDFLARE_API_TOKEN,CLOUDFLARE_ACCOUNT_ID). It willland when those are provisioned.
Both contributors are listed by name in
docs/CONTRIBUTORS.mdsotheir work is recognized regardless of merge status.
Summary by CodeRabbit