Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add monthly update template #11195

Closed
wants to merge 2 commits into from
Closed

Add monthly update template #11195

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac906c4
Add information about monthly update to README
majetideepak Oct 7, 2024
b5763d2
address review comments
majetideepak Oct 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions velox/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,38 @@ 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 (%ae)" | sort | uniq -c | sort -r
```
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.
- New monthly reports [must be added here](monthly-updates/). Each new report
must be linked to the [main document](monthly-updates.rst).
- 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Maybe we could add a pointer to where these files should be added, and/or a link to the directory?

- Add a reference to the PR if the update requires more context.