-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Clarify structure of commit messages #3626
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
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Since I have been merging most of the community contributions, I realized that I continuously rewrite commit messages with regards to the `Fixes #id` notation. Therefore, update the contribution guidelines to clarify that the fixes part should come at the end (as to not clutter the message). Also, link to the commit guide that I usually refer to, which also clarifies that the commit title should start with a verb.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3626 +/- ##
============================================
+ Coverage 86.44% 86.45% +0.01%
Complexity 2956 2956
============================================
Files 341 341
Lines 8985 8985
Branches 1103 1103
============================================
+ Hits 7767 7768 +1
+ Misses 936 935 -1
Partials 282 282 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
raphw
approved these changes
Mar 28, 2025
bric3
approved these changes
Mar 29, 2025
Maybe worth rewording this here I wonder if there's any bot that can perform this check for us ? |
This was referenced Apr 7, 2025
svc-squareup-copybara
pushed a commit
to cashapp/misk
that referenced
this pull request
Apr 7, 2025
| Package | Type | Package file | Manager | Update | Change | |---|---|---|---|---|---| | [org.mockito:mockito-core](https://github.com/mockito/mockito) | dependencies | misk/gradle/libs.versions.toml | gradle | minor | `5.16.1` -> `5.17.0` | | [software.amazon.awssdk:sdk-core](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.31.15` -> `2.31.16` | | [software.amazon.awssdk:sqs](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.31.15` -> `2.31.16` | | [software.amazon.awssdk:dynamodb-enhanced](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.31.15` -> `2.31.16` | | [software.amazon.awssdk:dynamodb](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.31.15` -> `2.31.16` | | [software.amazon.awssdk:aws-core](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.31.15` -> `2.31.16` | | [software.amazon.awssdk:bom](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.31.15` -> `2.31.16` | | [software.amazon.awssdk:auth](https://aws.amazon.com/sdkforjava) | dependencies | misk/gradle/libs.versions.toml | gradle | patch | `2.31.15` -> `2.31.16` | --- ### Release Notes <details> <summary>mockito/mockito (org.mockito:mockito-core)</summary> ### [`v5.17.0`](https://github.com/mockito/mockito/releases/tag/v5.17.0) <sup><sup>*Changelog generated by [Shipkit Changelog Gradle Plugin](https://github.com/shipkit/shipkit-changelog)*</sup></sup> ##### 5.17.0 - 2025-04-04 - [7 commit(s)](mockito/mockito@v5.16.1...v5.17.0) by Adrian Roos, Andre Kurait, Jan Ouwens, Rafael Winterhalter, Taeik Lim, Thach Le, Tim van der Lippe - Fixes [#​3631](mockito/mockito#3631): Fix broken banner image link [(#​3632)](mockito/mockito#3632) - Banner image is broken [(#​3631)](mockito/mockito#3631) - Update exception message with mockito-inline [(#​3628)](mockito/mockito#3628) - Clarify structure of commit messages [(#​3626)](mockito/mockito#3626) - Fixes [#​3622](mockito/mockito#3622): MockitoExtension fails cleanup when aborted before setup [(#​3623)](mockito/mockito#3623) - MockitoExtension fails cleanup when aborted before setup [(#​3622)](mockito/mockito#3622) - Since mockito-inline has been removed, the exception messages with `mockito-inline` should be modified. [(#​3621)](mockito/mockito#3621) - Fixes [#​3171](mockito/mockito#3171): Fall back to Throwable Location strategy on Android [(#​3619)](mockito/mockito#3619) - Fixes [#​3615](mockito/mockito#3615) : broken links to javadoc.io [(#​3616)](mockito/mockito#3616) - Broken links to javadoc.io [(#​3615)](mockito/mockito#3615) - Mocks are not working on particular devices after update Android SDK from 33 to 34 [(#​3171)](mockito/mockito#3171) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 6pm every weekday,before 2am every weekday" in timezone Australia/Melbourne, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Never, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). GitOrigin-RevId: 610e79d658b797b4e7b64d856b60fcbe8aa64650
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since I have been merging most of the community contributions, I realized that I continuously rewrite commit messages with regards to the
Fixes #id
notation.Therefore, update the contribution guidelines to clarify that the fixes part should come at the end (as to not clutter the message). Also, link to the commit guide that I usually refer to, which also clarifies that the commit title should start with a verb.