feat(eng): add repo-specific contributor types #507
Conversation
- Add eng/README.md documenting maintainer utilities - Add eng/contributor-report.mjs for generating contributor reports - Add eng/add-missing-contributors.mjs for automating contributor additions - Add eng/utils/graceful-shutdown.mjs for script lifecycle management - Update eng/update-readme.mjs with minor fixes - Update package.json with new contributor scripts Generated-by: GitHub Copilot <[email protected]> Signed-off-by: Ashley Childress <[email protected]>
- Modify generateMarkdownReport to include per-user sections with PR details - Remove total PR count and simplify PR link format Commit-generated-by: GitHub Copilot <[email protected]> Signed-off-by: Ashley Childress <[email protected]>
There was a problem hiding this comment.
Pull request overview
This PR enhances the contributor recognition system by adding custom contribution types specific to this repository (instructions, prompts, agents, collections) and implements automated contributor detection and reporting tooling.
Key changes:
- Custom contributor types configured in
.all-contributorsrcto better reflect repo-specific contributions - New contributor reporting scripts that analyze merged PRs and detect missing contributors
- Updated CI workflow to automatically check and report missing contributors weekly
Reviewed changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
.all-contributorsrc |
Adds custom contribution types (instructions, prompts, agents, collections), ignore list, and migrates existing contributors to new types |
package.json |
Adds contributors:report script and updates keywords |
eng/contributor-report.mjs |
New script to generate markdown reports of missing contributors by analyzing merged PRs |
eng/add-missing-contributors.mjs |
New script to automatically add missing contributors with inferred contribution types |
eng/utils/graceful-shutdown.mjs |
Utility for graceful shutdown handling in Node scripts |
eng/README.md |
Documentation for the new contributor tooling |
.github/workflows/contributors.yml |
Updates workflow to check/report missing contributors and adds timeout |
CONTRIBUTING.md |
Documents the new contributor recognition process and custom types |
README.md |
Auto-generated changes reflecting new contributor types and badge updates |
.gitignore |
Excludes reports directory from version control |
| const match = upstreamUrl.match(/github\.com:([^/]+)\/([^/]+?)(?:\.git)?$/); | ||
| if (match) return `${match[1]}/${match[2]}`; | ||
| } | ||
| } catch (e) { | ||
| console.debug('upstream not found, trying origin'); | ||
| } | ||
|
|
||
| try { | ||
| const originUrl = execSync('git config --get remote.origin.url', { | ||
| encoding: 'utf8', | ||
| stdio: ['pipe', 'pipe', 'pipe'] | ||
| }).trim(); | ||
| const match = originUrl.match(/github\.com:([^/]+)\/([^/]+?)(?:\.git)?$/); | ||
| if (match) return `${match[1]}/${match[2]}`; |
There was a problem hiding this comment.
The regex pattern for matching GitHub URLs only supports SSH format (github.com:owner/repo) but not HTTPS format (github.com/owner/repo). This will fail for users who have configured their Git remotes using HTTPS URLs.
| execSync(`gh pr comment ${prNumber} --repo ${repo} --body "${body.replace(/"/g, '\\"')}"`, { | ||
| encoding: 'utf8', | ||
| stdio: ['pipe', 'inherit', 'inherit'], | ||
| timeout: DEFAULT_CMD_TIMEOUT | ||
| }); |
There was a problem hiding this comment.
Escaped double quotes in the command body may not work correctly on all platforms. On Windows, this escaping pattern can fail. Consider using stdio 'inherit' or writing the body to a temporary file instead of escaping quotes in the shell command.
aaronpowell
left a comment
aaronpowell
left a comment
There was a problem hiding this comment.
ooo nifty, I didn't know you could do something like this.
There are some comments from Copilot on the regexes and stuff, can you review to see if any are actually valid
| jobs: | ||
| contributors: | ||
| runs-on: ubuntu-latest | ||
| timeout-minutes: 12 |
There was a problem hiding this comment.
is it really likely to hit 12 minutes?
There was a problem hiding this comment.
No, not by triple 😆 I defaulted to enterprise rules. I'll fix it.
3 participants
Pull Request Checklist
npm startand verified thatREADME.mdis up to date.Description
@aaronpowell
I realize I probably should have started a discussion first, but I started out just playing with the contributors library and got a little carried away 😆 Tbh, I'm not incredibly attached—I just hate wasting code when it could be useful. Let me know if you want changes or something taken back out!
Type of Contribution
Additional Notes
I had to stop myself from adding a bot that does all this for you automatically! I figure less is safer, so I kept everything to the report-friendly version and an auto-add script strictly for local use. That last one I wasn't going to include at all, but then decided it could be used for automation later if one were so inclined.
This is what that report looks like with markdown formatted in workflow output summary:
By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.