Fix missing -m flag in git commit command Update CONTRIBUTING.md #1215
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.
Description:
This PR fixes an issue where the
git commit
command in the contributing guide was missing the necessary-m
flag for the commit message. The original line:git commit 'Fix some bug short description #123'
is incorrect because it does not include the
-m
flag, which is required to specify the commit message in Git.The corrected command should be:
git commit -m "Fix some bug short description #123"
Importance:
Without the
-m
flag, the command will fail, and users will encounter an error when trying to commit changes. This fix ensures that the instructions are correct and that contributors can follow the guide without encountering problems during their workflow. Providing clear and accurate instructions is crucial for streamlining the contribution process and avoiding unnecessary confusion for new contributors.PR Checklist