Skip to content

Commit

Permalink
Add information about monthly update to README
Browse files Browse the repository at this point in the history
  • Loading branch information
majetideepak committed Oct 8, 2024
1 parent 96944d5 commit 3b9b57b
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions velox/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,34 @@ git commit -m "Update documentation"
# This will get the website updated.
git push -f upstream update-docs:gh-pages
```

## Monthly Updates
The monthly update report is generated manually using 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 with the new additions with `Add` followed by
the fixes using `Fix`.
- Group similar contributions together. Example: All Presto
scalar functions can be combined in one line.

0 comments on commit 3b9b57b

Please sign in to comment.