move .mailmap to docs and update README

facebookincubator · Nov 24, 2024 · baa3fdd · baa3fdd
1 parent 1679d9c
commit baa3fdd
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/.mailmap → velox/docs/.mailmap b/.mailmap → velox/docs/.mailmap
diff --git a/velox/docs/README.md b/velox/docs/README.md
@@ -51,11 +51,19 @@ The goal of the monthly update is for Velox users to understand the latest
 improvements and changes to Velox.
 This report is generated manually with the help of the following commands and template.
 
-Command to get the list of contributors and their contribution count in a specific month.
+Contributor affiliations are stored in `velox/docs/.mailmap`. This is used
+to improve the contributor stats accuracy as contributor email addresses
+aren't always consistent. New contributors must add to this file.
+To get the list of contributors in a specific month say June-2024, from the Velox root directory
+execute the following commands:
 ```
+cp velox/docs/.mailmap .
 git shortlog -se --since='June 1 2024' --until='June 30 2024'
+rm .mailmap
 ```
-Command to get the list of contributions in a specific month.
+
+To get the list of contributions in a specific month, from the Velox root directory
+execute the following command:
 ```
 git log --since='June 1 2024' --until='June 30 2024' --pretty=format:"%h%x09%an%x09%ad%x09%s"
 ```