doc: tweak onboarding instructions

Add some additional guidance based on something we missed in a recent onboarding step. Signed-off-by: Michael Dawson <[email protected]> PR-URL: #55212 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Jake Yuesong Li <[email protected]> Reviewed-By: Abdirahim Musse <[email protected]>
nodejs · Nov 17, 2024 · 9e7be23 · 9e7be23
1 parent 5b35836
commit 9e7be23
Showing 1 changed file with 7 additions and 0 deletions.
diff --git 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: <collaborator-nomination-issue-url>` to the commit message
   so that when the commit lands, the nomination issue url will be
   automatically closed.