Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix missing -m flag in git commit command Update CONTRIBUTING.md #1215

Merged
merged 1 commit into from
Nov 14, 2024

Conversation

famouswizard
Copy link
Contributor

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

  • Tests
  • Documentation
  • Added entry to CHANGELOG.md
  • Tried the feature on a public network

This PR fixes an issue where the git commit command in the contributing guide was missing the necessary -m flag for the commit message.
Copy link

codecov bot commented Nov 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.06%. Comparing base (f84b30d) to head (b7b4b85).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1215   +/-   ##
=======================================
  Coverage   92.06%   92.06%           
=======================================
  Files          49       49           
  Lines        1398     1398           
=======================================
  Hits         1287     1287           
  Misses        111      111           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f84b30d...b7b4b85. Read the comment docs.

Copy link
Member

@ericnordelo ericnordelo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ericnordelo ericnordelo merged commit b624598 into OpenZeppelin:main Nov 14, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants