vinothchandar commented on code in PR #13883:
URL: https://github.com/apache/hudi/pull/13883#discussion_r2342510944
##########
.github/PULL_REQUEST_TEMPLATE.md:
##########
@@ -1,27 +1,30 @@
+### Problem Statement
Review Comment:
```suggestion
### Describe the issue this Pull Request addresses ```
##########
.github/workflows/pr_title_validation.yml:
##########
@@ -0,0 +1,49 @@
+name: PR Title Validation
+
+on:
+ pull_request:
+ types: [opened, edited, reopened, synchronize]
+ branches:
+ - master
+ - branch-0.x
+
+concurrency:
+ group: pr-title-validation-${{ github.ref }}
+ cancel-in-progress: ${{ !contains(github.ref, 'master') &&
!contains(github.ref, 'branch-0.x') }}
+
+jobs:
+ validate-pr-title:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Validate PR title based on Conventional Commits spec
+ uses: amannn/action-semantic-pull-request@v6
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ with:
+ types: |
+ feat
+ fix
+ docs
+ style
+ refactor
+ perf
+ test
+ chore
+ improvement
+ blocker
+ security
+ requireScope: false
+ # Disable subject case validation to be more permissive
+ subjectPattern: ^.+$
+ subjectPatternError: |
+ The subject "{subject}" found in the pull request title "{title}"
+ is empty. Please provide a meaningful description.
+ # Allow ignoring certain labels
+ ignoreLabels: |
+ bot
+ ignore-semantic-pull-request
+ # Validate header format
+ validateSingleCommit: false
+ # Custom header pattern for conventional commits
+ headerPattern: '^(\w*)(?:\(([^)]*)\))?!?: (.*)$'
Review Comment:
handle `!` optionally for breaking changes
##########
.github/PULL_REQUEST_TEMPLATE.md:
##########
@@ -1,27 +1,30 @@
+### Problem Statement
+
+<!-- Describe the issue or motivation behind this change. What problem does
this solve? -->
+
### Change Logs
-_Describe context and summary for this change. Highlight if any code was
copied._
+<!-- Describe context and summary for this change. Highlight if any code was
copied. -->
Review Comment:
```suggestion
<!-- Short, plain-English summary of what users gain or what changed in
behavior. Followed by a detailed log of all the changes. Highlight if any code
was copied. -->
```
##########
.github/PULL_REQUEST_TEMPLATE.md:
##########
@@ -1,27 +1,30 @@
+### Problem Statement
+
+<!-- Describe the issue or motivation behind this change. What problem does
this solve? -->
+
### Change Logs
-_Describe context and summary for this change. Highlight if any code was
copied._
+<!-- Describe context and summary for this change. Highlight if any code was
copied. -->
### Impact
-_Describe any public API or user-facing feature change or any performance
impact._
+<!-- Describe any public API or user-facing feature change or any performance
impact. -->
-### Risk level (write none, low medium or high below)
+### Risk Level
-_If medium or high, explain what verification was done to mitigate the risks._
+<!-- Write none, low, medium or high. If medium or high, explain what
verification was done to mitigate the risks. -->
### Documentation Update
-_Describe any necessary documentation update if there is any new feature,
config, or user-facing change. If not, put "none"._
+<!-- Describe any necessary documentation update if there is any new feature,
config, or user-facing change. If not, put "none".
-- _The config description must be updated if new configs are added or the
default value of the configs are changed_
-- _Any new feature or user-facing change requires updating the Hudi website.
Please create a Jira ticket, attach the
- ticket number here and follow the
[instruction](https://hudi.apache.org/contribute/developer-setup#website) to
make
- changes to the website._
+- The config description must be updated if new configs are added or the
default value of the configs are changed.
+- Any new feature or user-facing change requires updating the Hudi website.
Please follow the
+ [instruction](https://hudi.apache.org/contribute/developer-setup#website) to
make changes to the website. -->
### Contributor's checklist
- [ ] Read through [contributor's
guide](https://hudi.apache.org/contribute/how-to-contribute)
-- [ ] Change Logs and Impact were stated clearly
+- [ ] Problem Statement, Change Logs and Impact are written clearly
Review Comment:
```suggestion
- [ ] Enough context is provided in the sections above
```
##########
.github/PULL_REQUEST_TEMPLATE.md:
##########
@@ -1,27 +1,30 @@
+### Problem Statement
+
+<!-- Describe the issue or motivation behind this change. What problem does
this solve? -->
+
### Change Logs
Review Comment:
```suggestion
### Summary and Changelog
```
##########
.github/workflows/pr_title_validation.yml:
##########
@@ -0,0 +1,49 @@
+name: PR Title Validation
+
+on:
+ pull_request:
+ types: [opened, edited, reopened, synchronize]
+ branches:
+ - master
+ - branch-0.x
+
+concurrency:
+ group: pr-title-validation-${{ github.ref }}
+ cancel-in-progress: ${{ !contains(github.ref, 'master') &&
!contains(github.ref, 'branch-0.x') }}
+
+jobs:
+ validate-pr-title:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Validate PR title based on Conventional Commits spec
+ uses: amannn/action-semantic-pull-request@v6
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ with:
+ types: |
+ feat
+ fix
Review Comment:
you can align with the latest update here.
https://github.com/apache/hudi/discussions/13877
• (feat) → A new feature (e.g., (feat) Add support for async compaction)
• (fix) → A bug fix (e.g., (fix) Resolve NPE in HoodieTimeline)
• (docs) → Documentation changes only (e.g., (docs) Update quickstart for
Spark 3.5)
• (style) → Code style, formatting, or lint-only changes (no logic impact)
• (refactor) → Code changes that neither fix a bug nor add a feature (e.g.,
cleanups, restructuring)
• (perf) → Performance improvements (e.g., (perf) Optimize bloom filter
lookup)
• (test) → Adding or correcting tests
• (chore) → Tooling, build system, CI/CD, or maintenance tasks
##########
.github/PR_TITLE_GUIDELINES.md:
##########
@@ -0,0 +1,95 @@
+# Pull Request Title Guidelines
+
+This project follows [Conventional
Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for PR
titles to ensure consistency and enable automated tooling.
+
+## Format
+
+```
+<type>(optional scope): <description>
+```
+
+For breaking changes that require attention, use
+
+```
+<type>(optional scope)!: <description>
+```
+
+## Types
Review Comment:
let's hyperlink to contributor guide..
##########
.github/PULL_REQUEST_TEMPLATE.md:
##########
@@ -1,27 +1,30 @@
+### Problem Statement
+
+<!-- Describe the issue or motivation behind this change. What problem does
this solve? -->
Review Comment:
```suggestion
<!--
Either describe the issue inline here with motivation behind the
changes
(or) link to an issue by including `Closes #<issue-number>` for
context.
If this PR includes changes the storage format, public APIs, or has
breaking changes, use `!` (e.g., feat!: ...).
-->
```
##########
.github/PULL_REQUEST_TEMPLATE.md:
##########
@@ -1,27 +1,30 @@
+### Problem Statement
+
+<!-- Describe the issue or motivation behind this change. What problem does
this solve? -->
+
### Change Logs
-_Describe context and summary for this change. Highlight if any code was
copied._
+<!-- Describe context and summary for this change. Highlight if any code was
copied. -->
### Impact
-_Describe any public API or user-facing feature change or any performance
impact._
+<!-- Describe any public API or user-facing feature change or any performance
impact. -->
-### Risk level (write none, low medium or high below)
+### Risk Level
-_If medium or high, explain what verification was done to mitigate the risks._
+<!-- Write none, low, medium or high. If medium or high, explain what
verification was done to mitigate the risks. -->
### Documentation Update
-_Describe any necessary documentation update if there is any new feature,
config, or user-facing change. If not, put "none"._
+<!-- Describe any necessary documentation update if there is any new feature,
config, or user-facing change. If not, put "none".
-- _The config description must be updated if new configs are added or the
default value of the configs are changed_
-- _Any new feature or user-facing change requires updating the Hudi website.
Please create a Jira ticket, attach the
- ticket number here and follow the
[instruction](https://hudi.apache.org/contribute/developer-setup#website) to
make
- changes to the website._
+- The config description must be updated if new configs are added or the
default value of the configs are changed.
+- Any new feature or user-facing change requires updating the Hudi website.
Please follow the
+ [instruction](https://hudi.apache.org/contribute/developer-setup#website) to
make changes to the website. -->
### Contributor's checklist
- [ ] Read through [contributor's
guide](https://hudi.apache.org/contribute/how-to-contribute)
-- [ ] Change Logs and Impact were stated clearly
+- [ ] Problem Statement, Change Logs and Impact are written clearly
- [ ] Adequate tests were added if applicable
- [ ] CI passed
Review Comment:
remove this?
##########
scripts/pr_compliance.py:
##########
@@ -385,33 +317,57 @@ def validate(self):
return False
self.section.error("","", "Please make sure you have filled out the
template correctly. You can find a blank template in
/.github/PULL_REQUEST_TEMPLATE.md")
return False
+
+ # Check if body contains GitHub issue link
+ def _has_github_issue_link(self):
+ # Look for GitHub issue patterns:
+ # - fixes #123, resolves #123, closes #123
+ # - fixes https://github.com/apache/hudi/issues/123
+ # - resolves https://github.com/apache/hudi/issues/123
+ # - closes https://github.com/apache/hudi/issues/123
Review Comment:
handles both `Closes` and `closes`?
##########
.github/PULL_REQUEST_TEMPLATE.md:
##########
@@ -1,27 +1,30 @@
+### Problem Statement
+
+<!-- Describe the issue or motivation behind this change. What problem does
this solve? -->
+
### Change Logs
-_Describe context and summary for this change. Highlight if any code was
copied._
+<!-- Describe context and summary for this change. Highlight if any code was
copied. -->
### Impact
-_Describe any public API or user-facing feature change or any performance
impact._
+<!-- Describe any public API or user-facing feature change or any performance
impact. -->
-### Risk level (write none, low medium or high below)
+### Risk Level
-_If medium or high, explain what verification was done to mitigate the risks._
+<!-- Write none, low, medium or high. If medium or high, explain what
verification was done to mitigate the risks. -->
Review Comment:
```suggestion
<!-- Accepted values: none, low, medium or high. Other than `none`, explain
the risk. If medium or high, explain what verification was done to mitigate the
risks. -->
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
