iroha icon indicating copy to clipboard operation
iroha copied to clipboard

[ci]: iroha2 commits message format checking

Open BAStos525 opened this issue 2 years ago • 3 comments

Signed-off-by: BAStos525 [email protected]

Description of the Change

Modify commit-msg git hook to enable commits message format checking.

Issue

It was the request to create git commits message checking process as it is implemented for Pull Request Title checking.

Benefits

To add the same policy for commits message format checking as Pull Request Title validation has it. It should help to make a commits message more more structured, readable and organized. I'm not sure if this commits policy should be mandatory for all contributors.

Possible Drawbacks

None.

BAStos525 avatar Sep 08 '22 21:09 BAStos525

While I appreciate the effort that's gone into this, it's terribly misguided.

  1. Nobody enables git hooks unless they specifically look into the hooks directory. I don't use the ones provided either.
  2. If this check were written in the scripts directory, it could be re-used in the CI.
  3. I'd much rather we checked that the commits in the PR conform to the format, rather than rely on the developer committing things in the right format. That's why we have rustfmt, scripts/check.sh and many other checks in the CI,

appetrosyan avatar Sep 09 '22 08:09 appetrosyan

Codecov Report

Merging #2723 (e62e09a) into iroha2-dev (a16d9c3) will decrease coverage by 1.93%. The diff coverage is 66.72%.

:exclamation: Current head e62e09a differs from pull request most recent head 119c7ad. Consider uploading reports for the commit 119c7ad to get more accurate results

@@              Coverage Diff               @@
##           iroha2-dev    #2723      +/-   ##
==============================================
- Coverage       67.61%   65.67%   -1.94%     
==============================================
  Files             140      166      +26     
  Lines           26173    29894    +3721     
==============================================
+ Hits            17696    19633    +1937     
- Misses           8477    10261    +1784     
Impacted Files Coverage Δ
actor/src/actor_id.rs 90.00% <ø> (ø)
actor/src/deadlock.rs 100.00% <ø> (ø)
cli/derive/src/lib.rs 92.30% <ø> (+17.58%) :arrow_up:
cli/src/event.rs 41.86% <ø> (ø)
cli/src/main.rs 1.09% <0.00%> (-0.26%) :arrow_down:
cli/src/stream.rs 81.39% <ø> (ø)
cli/src/torii/mod.rs 28.88% <0.00%> (ø)
client/src/http.rs 47.82% <ø> (ø)
client/src/http_default.rs 41.59% <ø> (-18.59%) :arrow_down:
client_cli/src/main.rs 0.27% <0.00%> (+0.01%) :arrow_up:
... and 213 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

codecov[bot] avatar Sep 12 '22 17:09 codecov[bot]

  • Release workflows are triggered. Needs to re-target the branch? image
  • Follow the guide for the commit message format image

To update the branch was helped.

BAStos525 avatar Sep 13 '22 17:09 BAStos525

I think we don't need this at this point. We should revisit this later, after we've set up a new contributing style guide.

appetrosyan avatar Sep 29 '22 06:09 appetrosyan