hermes-agent/contributors/README.md
ethernet e78e3a77be refactor(release): move the author map out of release.py
release.py was 2,804 lines, 2,076 of them the frozen legacy author dict.
The map and its resolver now live in scripts/releases/: authors.py holds
the directory loader, the merged AUTHOR_MAP and resolve_author, and
authors_legacy.py holds only the frozen LEGACY_AUTHOR_MAP literal (same
1,895 entries, same order). release.py drops to 707 lines.

The contributor-check job and audit_pr_attribution.py grep the legacy
file for quoted emails, so both now read authors_legacy.py. The
importers (contributor_audit.py, add_contributor.py), contributors/README
and the tests read the defining modules. No behaviour change.
2026-09-24 14:08:22 -04:00

38 lines
1.4 KiB
Markdown

# Contributor email → GitHub login mappings
This directory replaces appending entries to `AUTHOR_MAP` in
`scripts/releases/authors_legacy.py`. The old dict caused constant merge conflicts when
several salvage PRs landed at once — every PR edited the same lines of the
same file. Here, **each mapping is its own file**, and file additions never
conflict.
## Adding a mapping
One file per commit-author email, under `emails/`:
```bash
python3 scripts/add_contributor.py <email> <github-login>
# or by hand:
echo "<github-login>" > contributors/emails/<email>
```
- File **name** = the exact commit-author email (as shown by `git log --format='%ae'`).
- File **content** = the GitHub login on the first non-comment line.
Lines starting with `#` are comments (use them for the PR reference).
Example — `contributors/emails/[email protected]`:
```
janedoe
# PR #12345 salvage (gateway: fix session key routing)
```
## Rules
- Do NOT add new entries to `AUTHOR_MAP` in `scripts/releases/authors_legacy.py`. That dict
is frozen legacy data; the release tooling merges it with this directory
(directory entries win on duplicates).
- GitHub noreply emails (`<id>+<login>@users.noreply.github.com` and
`<login>@users.noreply.github.com`) auto-resolve — no file needed.
- The `Contributor Attribution Check` CI job fails a PR whose commits carry
an unmapped email; the failure message prints the exact command to run.