Skip to content

Commit be22cf3

Browse files
committed
templates: Improve fixCommitWarning.
- Adds an explanation of why linking the PR to the issue is helpful. - Links to the commit message documentation.
1 parent 81ab420 commit be22cf3

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

config/templates/fixCommitWarning.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Hello @{author}, it seems like you have referenced #{issues} in your pull request description, but you have not referenced {issuePronoun} in your commit message description(s). When you reference an issue in a commit message, it automatically closes the corresponding issue when the commit is merged.
1+
Hello @{author}, it seems like you have referenced #{issues} in your pull request description, but you have not referenced {issuePronoun} in your commit message description(s). Referencing an issue in a commit message automatically closes the corresponding issue when the commit is merged, which makes the issue tracker easier to manage.
22

33
Please run `git commit --amend` in your command line client to amend your commit message description with `Fixes #{fixIssues}.`.
44

@@ -14,6 +14,6 @@ Date: Sat Mar 18 13:42:40 2017 -0700
1414
Fixes #51.
1515
```
1616

17-
Thank you for your contributions to Zulip!
17+
To learn how to write a great commit message, please refer to our [guide](https://zulip.readthedocs.io/en/latest/contributing/version-control.html#commit-messages).
1818

1919
<!-- fixCommitWarning -->

0 commit comments

Comments
 (0)