Skip to content

Release notes should mention contributor GitHub handles #736

Closed

Description

@tigercraft4

Summary

The latest release credits contributors by display/name text, but does not tag their GitHub handles. That means contributors are credited visually, but GitHub does not notify them and the release notes do not link back to their profiles.

Evidence

The published v9.1.0 release has a Notes for contributors section that says:

Thanks to FF (Today/Sleep/Health refactors, GATT family detection), digitalerdude (workout backfill, journal fix, sleep consistency, SpO2 instrumentation, steps stepper, alarm diagnostic), Pipiche (Oura IBI fix, feature-status probe, protocol docs), Kaveman (Gradle supply chain), and Jonas Bergler (bundle ID prefix, development team config, build fix) — and to everyone who filed the reports behind these fixes.

Those names are not GitHub mentions. The release includes merged PRs from these handles:

So the release credits contributors, but not in a way that tags/notifies them. Older release/changelog entries do use handles in some places, for example Thanks @sunny-noop, Thanks @ruedigermunz, etc., so this looks like process drift rather than an intentional no-mentions policy.

Suggested fix

  • In GitHub release notes, use GitHub handles for contributor credits, e.g. Thanks to @tigercraft4, @digitalerdude, @pipiche38, @kavemang, and @jbergler ....
  • If release notes are generated manually, add this to the release checklist.
  • If release notes are generated from merged PRs, collect each merged PR author login and emit @login in the contributors section.
  • Keep display names optional, but include the handle somewhere so the credit is clickable and sends a notification.

Why it matters

Contributor credit is part of community hygiene. The current text is easy to miss, cannot notify contributors, and is inconsistent with older release notes that did mention people by handle.

Activity

  1. reopened this on Jul 25, 2026
  2. ryanbr commented on Jul 25, 2026

    @ryanbr
    Owner

    Thanks for the report, and for the handle mapping — it was accurate, including #677.

    #790 has landed the convention and the tooling:

    • Release notes credit third-party work by @handle. docs/releases/v9.1.0.md now uses handle links, and since the release workflow builds the GitHub release body from that file, the convention applies from the next release onward.
    • The convention is written into the contributor guide so it does not drift again, covering both merged-PR authors and the reporters whose issues drove a fix.
    • Tools/release-contributors.sh <since-date|since-tag> collects the third-party handles for a release range, so the handles no longer have to be gathered by hand.

    Reopening, because your diagnosis was incomplete in a way that matters — through no fault of the report, since the cause is not visible from the release page.

    This is not only hand-written drift. The release workflow post-processes GitHub's generated notes and strips every by @author credit, then deletes the New Contributors block outright. Measured against v9.1.0's real generated notes, that removed 66 credits covering 7 distinct third-party contributors, plus the block. So the four suggested fixes, implemented exactly as written, would still have left your handle off the next release.

    The stated reason in the workflow was that this is a solo fork. That is no longer true: 16 people have landed merged PRs here, 7 of them in v9.1.0 alone.

    The fix is written and verified — strip only the maintainer's own credit, which is noise on nearly every line and notifies nobody, and keep everyone else's. On v9.1.0's notes it keeps 35 third-party credits, removes all 31 maintainer ones, and restores New Contributors. It is waiting on a token scope to push, so this issue stays open until that lands.

    One deliberate exception: the already-published v9.1.0 release body keeps its original text. The workflow only builds a body when creating a release, so it will not refresh an existing one, and rewriting published pages is out of scope here.

  3. added 2 commits that reference this issue on Jul 25, 2026
  4. ryanbr commented on Jul 25, 2026

    @ryanbr
    Owner

    #792 has landed, so this is now genuinely resolved rather than only half of it.

    The release workflow no longer strips contributor handles. It removes only the maintainer's own by @… credit — noise on nearly every line, and a self-mention notifies nobody — and keeps everyone else's. The New Contributors block is no longer deleted either. Checked against v9.1.0's real generated notes: 35 third-party credits kept where 0 survived before, all 31 maintainer ones removed, block restored.

    Combined with #790, from the next release onward:

    • the curated credit line at the top uses @handle links, from docs/releases/<TAG>.md, which is what the release body is built from
    • every PR in the auto-generated list below it keeps its author's handle
    • first-time contributors get a New Contributors section again
    • Tools/release-contributors.sh <since-date|since-tag> collects the handles, so the credit line is not assembled by hand

    Thanks for filing this with the handle mapping and the evidence — the report is what turned up the workflow scrub, which was not visible from the release page and would not have been found by fixing the prose alone.

    The already-published v9.1.0 body keeps its original text: the workflow only builds a body when it creates a release, so it will not refresh an existing one, and rewriting published pages is out of scope here.

  5. added a commit that references this issue on Jul 27, 2026
  6. 2 remaining items

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions