slop/vague-commit-messages
Commit subjects say what changed
| Severity | info |
| Tiers | all |
| Stacks | any |
| Scope | root |
| Kind | expr |
| Source | library v0.4.0 |
| Selected by | fleetlint-slop@v0.4.0 |
Requirement
No commit in the recent history (params.commits, default 200) has a description that is only fix, update, wip, changes, misc or cleanup, with or without a Conventional Commits type (fix: update is as vague as update).
Why
The history is the record of why the code changed; a one-word subject records nothing.
Applies when
repo.has_gitCheck
For each item in:
commits(params.commits)!item.subject.matches(r'(?i)^(\w+(\([^)]*\))?!?:\s*)?(fix(es)?|update[sd]?|wip|changes?|misc|stuff|tmp|test|minor|cleanup|\.)\.?$')Parameters
commits:200
Fix
Write the subject from the diff; squash work-in-progress commits before merging.
Agent instruction: Write subjects from the diff. Do not rewrite pushed history without the user’s decision.
Sources
- https://git-scm.com/docs/git-commit (spec, DISCUSSION)
- https://fleetlint.org/baseline/#slop (convention)
- https://fleetlint.org/slop/#commits-and-history
Generated by fleetlint docs from catalog v0.4.0.