docs: add contributor grid to README - #273
Merged
Merged
Conversation
Grid shows presence (contrib.rocks, sourced from GitHub's contributor API); CONTRIBUTORS.md remains where specific credit lives. The two are linked directly in the README text so the grid doesn't stand alone as an undifferentiated signal, matching why CONTRIBUTORS.md exists in the first place. Note on the cited precedent: deepchecks/deepchecks, the repo this task was modeled on, turned out to use the all-contributors bot/spec (a hand-maintained per-person table with contribution-type tags), not contrib.rocks -- confirmed by fetching its real README rather than assuming. Went with contrib.rocks anyway: it's a single static embed with no bot install or per-contribution-type tagging to invent, and AVE already has CONTRIBUTORS.md doing the detailed-credit job properly, so reproducing all-contributors' partial overlap with that file would be redundant, lower-fidelity duplication rather than a genuine gap. Known, pre-existing limitation, not introduced here: contrib.rocks sources from the same GitHub contributor API already found to have real quirks in this project (squash-merged PRs collapse to one contributor entry per merge commit; at least one contributor's commits are attributed under a company name rather than a personal one at the git level). The grid will inherit this, same as any consumer of that API would.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a contributor grid near the end of
README.md, in the existing "Governance and contributing" area (right before the "Related" section), linked directly toCONTRIBUTORS.mdin the same section so the grid (presence) never stands alone from the specific credit (what each person actually did).Precedent check, worth flagging: the task that prompted this cited
deepchecks/deepchecksas usingcontrib.rocks. Fetched its real README directly — it actually uses the all-contributors bot/spec (a hand-maintained per-person table with contribution-type emoji tags), notcontrib.rocks. Went withcontrib.rocksanyway rather than switching to match the real precedent: it's a single static embed with nothing to install and no per-contribution-type tagging to invent, and AVE already hasCONTRIBUTORS.mddoing the detailed-credit job properly — reproducing all-contributors' table would partially duplicate that file at lower fidelity, not fill a real gap.Confirmed the embed actually renders for this repo before opening this, not just that the markdown is syntactically valid:
https://contrib.rocks/image?repo=aveproject/avereturns a live SVG with real embedded avatar images (6, matchingCONTRIBUTORS.md's current contributor count), andhttps://github.com/aveproject/ave/graphs/contributorsresolves.The pointer sentence names the same four specific contributions
CONTRIBUTORS.mddocuments (astrogilda's crosswalk schema/pin-status design, predictor2718's cfgaudit crosswalk, mmaxjr's validator fix, Alex Greenshpun's attribution correction) — verified against the real, current file, not assumed.Known, pre-existing limitation the grid inherits, not introduced here:
contrib.rockssources from the same GitHub contributor API this project already found has real quirks (squash-merged PRs collapse to one entry per merge commit; at least one contributor's commits are attributed under a company name rather than a personal one at the git level). Noted in the commit message for future reference, not called out in the README itself.