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.
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: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:
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