OpenZeppelin / cairo-contracts

OpenZeppelin Contracts written in Cairo for Starknet, a decentralized ZK Rollup
https://docs.openzeppelin.com/contracts-cairo
MIT License
826 stars 339 forks source link

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

Closed famouswizard closed 5 days ago

famouswizard commented 5 days ago

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

codecov[bot] commented 5 days ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

Additional details and impacted files ```diff @@ 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](https://app.codecov.io/gh/OpenZeppelin/cairo-contracts/pull/1215?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=OpenZeppelin). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=OpenZeppelin) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/OpenZeppelin/cairo-contracts/pull/1215?dropdown=coverage&src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=OpenZeppelin). Last update [f84b30d...b7b4b85](https://app.codecov.io/gh/OpenZeppelin/cairo-contracts/pull/1215?dropdown=coverage&src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=OpenZeppelin). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=OpenZeppelin).