Skip to content

Avoid using generic subjects #198

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

Merged
merged 1 commit into from
Feb 21, 2025
Merged

Avoid using generic subjects #198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion queue.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
* cppcheck-suppress nullPointer
*/


/* Change */
/* Create an empty queue */
struct list_head *q_new()
{
Expand Down
13 changes: 8 additions & 5 deletions scripts/commit-msg.hook
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,11 +288,14 @@ validate_commit_message() {
# Count non-comment, non-blank lines excluding "Change-Id:".
NON_COMMENT_COUNT=$(sed '/^[[:space:]]*#/d;/^[[:space:]]*$/d;/^[[:space:]]*Change-Id:/d' "${COMMIT_MSG_FILE}" | wc -l | xargs)

# If the subject is oversimplified for a queue function OR queue.c is modified,
# and there is only one meaningful line, issue a warning.
if { [[ "${COMMIT_SUBJECT_TO_PROCESS}" =~ ^(Implement|Finish|Complete)[[:space:]]+q_[[:alnum:]_]+\(?\)?$ ]] || \
git diff --cached --name-only | grep -Eq '(^|/)queue\.c$'; } && [ "${NON_COMMENT_COUNT}" -le 1 ]; then
add_warning 1 "Commit message oversimplified. Use the commit message body to explain what and why."
# If queue.c is modified and the commit message is oversimplified, forbid generic subjects.
if git diff --cached --name-only | grep -Eq '(^|/)queue\.c$'; then
if [ "${NON_COMMENT_COUNT}" -le 1 ]; then
add_warning 1 "Commit message oversimplified. Use the commit message body to explain what and why."
fi
if [[ "${COMMIT_SUBJECT_TO_PROCESS}" =~ ^(Complete|Finish|Done)[[:space:]]+ ]]; then
add_warning 1 "Avoid using generic subjects starting with 'Complete', 'Finish', or 'Done'"
fi
fi

# 9. Do not start the subject line with whitespace
Expand Down