Skip to content

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.

Sign up for GitHub

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 2 commits into from
Mar 29, 2025
Merged

Clarify structure of commit messages #3626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fdf4995
Clarify structure of commit messages
TimvdLippe Mar 28, 2025
4024ff7
Update pul request template
TimvdLippe Mar 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

## Pull request criteria

* **At least one commit message** in the PR starts with `Fixes #id : ` where `id` is an [issue tracker](https://github.com/mockito/mockito/issues) id. This allows automated release notes generation. Also GitHub will track the issue and [close it](https://github.com/blog/1386-closing-issues-via-commit-messages) when the PR is merged.
* **At least one commit message** in the PR ends with `Fixes #id` where `id` is an [issue tracker](https://github.com/mockito/mockito/issues) id. This allows automated release notes generation. Also GitHub will track the issue and [close it](https://github.com/blog/1386-closing-issues-via-commit-messages) when the PR is merged.
* Use `@since` tags for new public APIs
* Include tests
* Document public APIs with examples
Expand Down Expand Up @@ -42,13 +42,25 @@ Things we pay attention in a PR :
* On pull requests, please document the change, what it brings, what is the benefit.
* **Clean commit history** in the topic branch in your fork of the repository, even during review. That means that commits are _rebased_ and _squashed_ if necessary, so that each commit clearly changes one things and there are no extraneous fix-ups.

For that matter it's possible to commit [_semantic_ changes](https://lemike-de.tumblr.com/post/79041908218/semantic-commits). _Tests are an asset, so is history_.
_Tests are an asset, so is history_.

_Example gratia_:
_Example gratia_ (based on https://cbea.ms/git-commit/):

```
Fixes #73 : The new feature
Fixes #73 : Refactors this part of Mockito to make feature possible
Enable feature X to do Y

Include some background information here.

Fixes #73
```

```
Fix bug B with feature A

Include some background information here.
Add example scenario/context.

Fixes #73
```

* In the code, always test your feature / change, in unit tests and in our `acceptance test suite` located in `org.mockitousage`. Older tests will be migrated when a test is modified.
Expand Down
15 changes: 3 additions & 12 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,4 @@
<!-- Hey,
Thanks for the contribution, this is awesome.
As you may have read, project members have somehow an opinionated view on what and how should be
Mockito, e.g. we don't want mockito to be a feature bloat.
There may be a thorough review, with feedback -> code change loop.
-->
<!--
If you have a suggestion for this template you can fix it in the .github/PULL_REQUEST_TEMPLATE.md file
-->

## Checklist

- [ ] Read the [contributing guide](https://github.com/mockito/mockito/blob/main/.github/CONTRIBUTING.md)
Expand All @@ -16,7 +8,6 @@ If you have a suggestion for this template you can fix it in the .github/PULL_RE
- [ ] Avoid other runtime dependencies
- [ ] Meaningful commit history ; intention is important please rebase your commit history so that each
commit is meaningful and help the people that will explore a change in 2 years
- [ ] The pull request follows coding style
- [ ] The pull request follows coding style (run `./gradlew spotlessApply` for auto-formatting)
- [ ] Mention `Fixes #<issue number>` in the description _if relevant_
- [ ] At least one commit should mention `Fixes #<issue number>` _if relevant_

- [ ] At least one commit should end with `Fixes #<issue number>` _if relevant_