doc: tweak onboarding instructions

mhdawson · targos · commit 297cb0da5a16 · 2024-10-04T19:20:23.000+02:00
Add some additional guidance based on something we missed in a recent onboarding step. Signed-off-by: Michael Dawson <midawson@redhat.com> PR-URL: #55212 Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jake Yuesong Li <jake.yuesong@gmail.com> Reviewed-By: Abdirahim Musse <abdirahim.musse@ibm.com>
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.
