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

[ci] #4502: Enforce Conventional Commits in PR titles #4523

Merged
merged 1 commit into from May 1, 2024

Conversation

nxsaken
Copy link
Contributor

@nxsaken nxsaken commented Apr 29, 2024

Description

Enforce Conventional Commits style in PR titles.

Linked issue

Closes #4502.

Benefits

See here.

Checklist

  • I've read CONTRIBUTING.md
  • I've used the standard signed-off commit format (or will squash just before merging)
  • All applicable CI checks pass (or I promised to make them pass later)
  • (optional) I've written unit tests for the code changes
  • I replied to all comments after code review, marking all implemented changes with thumbs up

@github-actions github-actions bot added CI iroha2-dev The re-implementation of a BFT hyperledger in RUST labels Apr 29, 2024
mversic
mversic previously approved these changes Apr 29, 2024
@mversic
Copy link
Contributor

mversic commented Apr 29, 2024

We don't enforce issue numbers in the PR anymore. I think this is good for these reasons:

  1. we shouldn't be putting issue numbers but rather PR numbers
  2. if you use "squash and merge" button on github it adds PR number automatically
  3. if you use "rebase and merge" then just add issue number manually to the end of your commit like github would do

Let's make sure that devs are notified of this change

@nxsaken
Copy link
Contributor Author

nxsaken commented Apr 29, 2024

CC recommends using footers for issue numbers:

fix(iroha_client_cli): ...

Refs: #issue_number

@mversic
Copy link
Contributor

mversic commented Apr 29, 2024

CC recommends using footers for issue numbers:

fix(iroha_client_cli): ...

Refs: #issue_number

yes, I know. I think the way github does it is quite convenient. Especially when generating content iroha-news or changelog. In that case I use git log --oneline to get a brief report of the commits and it's great to see PR issue numbers there instead of having to parse the body of the commit message

Signed-off-by: Nurzhan Sakén <nurzhan.sakenov@gmail.com>
@nxsaken nxsaken merged commit 0f4d568 into hyperledger:main May 1, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI iroha2-dev The re-implementation of a BFT hyperledger in RUST
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use conventional commits in PR titles
2 participants