Add: Add check for overlong lines in description block #681
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
self-requested a review
as a 
Conventional Commits Report
🚀 Conventional commits found. |
cfi-gb
reviewed
Mar 19, 2024
mbrinkhoff
requested changes
Mar 19, 2024
mbrinkhoff
requested changes
Mar 20, 2024
mbrinkhoff
approved these changes
Mar 21, 2024
mbrinkhoff
force-pushed
the
overlong_description_lines
branch
from
d6faddf to
5fc10f0
Compare
This was referenced Mar 21, 2024
cfi-gb
reviewed
Mar 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Adds a check for lines in the description block that are longer than 100 characters.
script_name is ignored because it cannot contain line breaks.
Severity for a too long line is Warning.
Severity for not finding the start or end of the description block is Error, because the check cannot work properly then.
Why
The coding style for description blocks specifies that lines should not exceed 100 characters.
References
Checklist