From ac906c4a7481a4cae496c9ca47976f161287d916 Mon Sep 17 00:00:00 2001
From: Deepak Majeti <deepak.majeti@ibm.com>
Date: Mon, 7 Oct 2024 11:23:26 -0400
Subject: [PATCH] Add information about monthly update to README

---
 velox/docs/README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/velox/docs/README.md b/velox/docs/README.md
index a46cfaec0689..2fb44a6d7669 100644
--- a/velox/docs/README.md
+++ b/velox/docs/README.md
@@ -45,3 +45,36 @@ git commit -m "Update documentation"
 # This will get the website updated.
 git push -f upstream update-docs:gh-pages
 ```
+
+## Monthly Updates
+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.
+```
+git log --since='June 1 2024' --until='June 30 2024' --pretty=format:"%an" | sort | uniq -c
+```
+Command to get the list of contributions in a specific month.
+```
+git log --since='June 1 2024' --until='June 30 2024' --pretty=format:"%h%x09%an%x09%ad%x09%s"
+```
+
+The following template is used to write a monthly update report. The main sections
+are as follows.
+- Documentation
+- Core Library
+- Presto Functions
+- Spark Functions
+- Hive Connector
+- Performance and Correctness
+- Build System
+- Credits
+
+Below are a few monthly update guidelines.
+- Each update should be in the imperative, present tense similar to a git commit.
+- In sections where applicable, start new additions with `Add` followed by
+  the fixes using `Fix`, followed by other updates.
+- Group similar contributions together. Example: All Presto scalar functions can be
+  combined in one line.
+- Add a reference to the PR if the update requires more context.