feat(framework): credit GitHub contributors in generated release notes
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 55/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- github, github-actions, typescript
Research direction
Start by reading release-please-config.json and .github/workflows/ci.yml, then compare the generated v5.10.0 release. Trace where root and component release notes are produced and run the existing tests before changing behavior. Done means human PR authors are credited once per applicable release, bots are excluded, and repeated generation remains unchanged.
Written by the indexing model from the issue text.
Description
Problem
Release Please lists changes, pull requests and commits, but the generated GitHub releases do not explicitly credit human contributors by GitHub handle.
The current v5.10.0 release contains no contributor section or @handle mentions.
Scope
- Resolve the human authors of pull requests included in each release.
- Add a contributor section to generated GitHub release notes.
- Mention each contributor by GitHub handle.
- Deduplicate contributors with multiple changes.
- Exclude bots and GitHub Apps.
- Keep release generation idempotent.
- Apply attribution to the root release and affected component releases.
Acceptance criteria
- Every human PR author included in a release is mentioned exactly once.
- Bots and GitHub Apps are excluded.
- Multiple contributions by one author produce one mention per release.
- Re-running the workflow does not duplicate the section or handles.
- Contributors whose changes are absent from a component release are not credited in that component release.
- Tests cover multiple contributors, a repeated contributor and a bot.
- Release notes remain generated by the automated release pipeline.
Prior art in this repo
release-please-config.json.github/workflows/ci.yml- Release
v5.10.0.
Out of scope
- Rewriting Git history.
- Crediting automated accounts.
- Manually maintained changelogs.
- Crediting people without a traceable GitHub contribution in the release range.
- Dominant language
- TypeScript
- Stars
- 481
- Forks
- 45
- Avg merge
- 14h 27m
- Merged PRs (30d)
- 111
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ai-driven-dev/framework
-
refactor(aidd-orchestrator): the check zone says when to stop, and reviews its axes in one round Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
ai-driven-dev/framework#887 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
ai-driven-dev/framework#873 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
ai-driven-dev/framework#872 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
ai-driven-dev/framework#625 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
ai-driven-dev/framework#467 · 1 comment ·
All issues in ai-driven-dev/framework
Similar issues
-
VerificationGate: ATTRIBUTION quote guard never matches a normal quotation (\b around the quote) Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
danielmiessler/LifeOS#2234 ·
-
T: Bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
Mend: dependency security vulnerability untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 70/100