chia7712 commented on code in PR #19159:
URL: https://github.com/apache/kafka/pull/19159#discussion_r1986686393
##########
.github/workflows/README.md:
##########
@@ -122,6 +122,15 @@ structure of the PR
Note that the pr-reviewed.yml workflow uses the `ci-approved` mechanism
described
above.
+The following checks are performed on our PRs:
+* Title is not too short or too long
+* Title starts with "KAFKA-", "MINOR-", or "HOTFIX-"
Review Comment:
"MINOR", or "HOTFIX"
##########
.github/scripts/pr-format.py:
##########
@@ -105,50 +112,55 @@ def parse_trailers(title, body) -> Dict:
body = gh_json["body"]
reviews = gh_json["reviews"]
- warnings = []
- errors = []
-
- # Check title
- if title.endswith("..."):
- errors.append("Title appears truncated")
-
- if len(title) < 15:
- errors.append("Title is too short")
+ checks = [] # (bool (0=ok, 1=error), message)
- if len(title) > 120:
- errors.append("Title is too long")
+ def check(positive_assertion, ok_msg, err_msg):
+ if positive_assertion:
+ checks.append((0, f"{ok} {ok_msg}"))
+ else:
+ checks.append((1, f"{err} {err_msg}"))
- if not title.startswith("KAFKA-") and not title.startswith("MINOR") and
not title.startswith("HOTFIX"):
- errors.append("Title is missing KAFKA-XXXXX or MINOR/HOTFIX prefix")
+ # Check title
+ check(not title.endswith("..."), "Title is not truncated", "Title appears
truncated")
+ check(len(title) >= 15, "Title is not too short", "Title is too short")
+ check(len(title) < 120, "Title is not too long", "Title is too long")
Review Comment:
While we could debate this point indefinitely and then never talking to each
other, establishing a title length limit is a constructive approach :)
--
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]
