This is an automated email from the ASF dual-hosted git repository.
zabetak pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/hive-site.git
The following commit(s) were added to refs/heads/main by this push:
new 5780c3c HIVE-28905: Update commit guidelines to not mention
contributors and reviewers (#47)
5780c3c is described below
commit 5780c3ccccf5e27b7859f82a2928c827467f0e03
Author: Stamatis Zampetakis <[email protected]>
AuthorDate: Fri Apr 18 14:21:27 2025 +0300
HIVE-28905: Update commit guidelines to not mention contributors and
reviewers (#47)
Update the guidelines with the outcome from the discussion in the dev list:
https://lists.apache.org/thread/p570y2020jzq5zym1kqvlx22hcddo435
---
content/docs/latest/howtocommit_27362108.md | 16 ++++++++++------
1 file changed, 10 insertions(+), 6 deletions(-)
diff --git a/content/docs/latest/howtocommit_27362108.md
b/content/docs/latest/howtocommit_27362108.md
index d7e1fdc..cd261e9 100644
--- a/content/docs/latest/howtocommit_27362108.md
+++ b/content/docs/latest/howtocommit_27362108.md
@@ -56,12 +56,16 @@ If a commit introduces new test failures, the preferred
process is to revert the
When you commit/merge a Pull Request, please:
1. Ensure that the Pull Request has a +1 vote, and that **24 hours have
elapsed since the first +1 vote was cast** on the Pull Request. Note that this
rule appears in the Hive Bylaws. Do not ignore it.
-2. Include the Jira issue id in the commit message, along with a short
description of the change and the name of the contributor. Be sure to get the
issue id right, as this causes Jira to link to the change in Git/Github.
-
- 1. if contributor is you then add the following suffix to commit
message "(<you>, reviewed by <reviewer>)". Example: "HIVE-123. Add awesomesauce
to the optimizer. (jvs, reviewed by Ashutosh Chauhan)"
- 2. if contributor is not you then add the following suffix to commit
message "(<contributor> via <you>)". Example: "HIVE-123. Add awesomesauce to
the optimizer. (Mike Brakestoner, reviewed by Ashutosh Chauhan)"
- 1. Additionally: "Co-authored-by: Ayush Saxena
<ayushsaxena@[apache.org](http://apache.org)>" can be used to attribute any
additional code contributors.
-3. Resolve the issue as fixed, thanking the contributor and the reviewers.
**Always set the "Fix Version"** at this point, but please only set a single
fix version, the earliest release in which the change will appear. However, if
a patch is backported to a point release (such as 1.0.2) then multiple fix
versions should be set so that the automated release notes can list the Jira
issue for the point release as well as the primary release.
+2. Include the Jira issue id in the commit message, along with a short
description of the change. Be sure to get the issue id right, in order to have
proper links between Jira and GitHub.
+3. Append the Pull Request id, in the commit subject to track the relation
between the commit and the respective Pull Request.
+4. Add `Co-authored-by: Ayush Saxena <[email protected]>` in the body of
the message if multiple people contributed to the Pull Request.
+5. Resolve the JIRA issue as fixed, and **set the "Fix Version"** to the
release in which the change will appear. If a patch is backported to a point
release (such as 1.0.2) then multiple fix versions should be set so that the
automated release notes can list the Jira issue for the point release as well
as the primary release.
+6. Thank the contributor(s), the reviewers, and the reporter of the issue (if
different from the contributor). It is easier to thank the people in GitHub by
mentioning their GitHub ids under the respective Pull Request.
+
+Below you can find a sample commit message that adheres to the guidelines
outlined here.
+```
+HIVE-27424: Display dependency:tree in GitHub actions (#5756)
+```
#### Committing Documentation
