Clarify commit message guidelines and improve error messages #4184
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
Revised the commit message section to provide clearer instructions. Each commit message now includes a subject and a body, separated by an empty line. The body must start with a capital letter and include a "Signed-off-by" line at the end. Signed-off-by: Nikolay Martyanov <nikolay@zededa.com>
OhmSpectator
force-pushed
the
feature/improve-commit-linter-message
branch
from
ff98361 to
35ee0f1
Compare
Updated the script to provide more detailed error messages when a commit has no body. Added a link to the CONTRIBUTING.md file for more information on commit message guidelines. Signed-off-by: Nikolay Martyanov <nikolay@zededa.com>
OhmSpectator
force-pushed
the
feature/improve-commit-linter-message
branch
from
35ee0f1 to
9fe1462
Compare
christoph-zededa
approved these changes
Aug 29, 2024
|
@rene, take a look, please =) |
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.
This PR includes the following changes:
Update commit message guidelines in CONTRIBUTING.md: Revised the commit message section to provide clearer instructions. Each commit message now includes a subject and a body, separated by an empty line. The body must start with a capital letter and include a "Signed-off-by" line at the end.
Clarify error message in check_commit_messages.py: Updated the script to provide more detailed error messages when a commit has no body. Added a link to the CONTRIBUTING.md file for more information on commit message guidelines.