From 297cb0da5a16adf6e12d8d61129c5521a356add0 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Thu, 3 Oct 2024 10:00:43 -0400 Subject: [PATCH] doc: tweak onboarding instructions Add some additional guidance based on something we missed in a recent onboarding step. Signed-off-by: Michael Dawson PR-URL: https://github.com/nodejs/node/pull/55212 Reviewed-By: Richard Lau Reviewed-By: Antoine du Hamel Reviewed-By: Rafael Gonzaga Reviewed-By: Luigi Pinca Reviewed-By: Jake Yuesong Li Reviewed-By: Abdirahim Musse --- onboarding.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/onboarding.md b/onboarding.md index e842c3b7e4eb57..0731161a4c4e25 100644 --- a/onboarding.md +++ b/onboarding.md @@ -216,6 +216,13 @@ needs to be pointed out separately during the onboarding. `git show --format=%B 6669b3857f0f43ee0296eb7ac45086cd907b9e94` * Collaborators are in alphabetical order by GitHub username. * Optionally, include your personal pronouns. +* The PR should include an addition to the + [mailmap](.mailmap) file if the email + being added to the collaborator list does not match the email used for + commits. Otherwise tooling will not see the collaborator as being active and + may suggest removing them. See + [gitmailmap](https://git-scm.com/docs/gitmailmap) for information on the + format of the mailmap file. * Add the `Fixes: ` to the commit message so that when the commit lands, the nomination issue url will be automatically closed.