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 16, 2024
1 parent 96944d5 commit ac906c4
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions velox/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit ac906c4

Please sign in to comment.