Skip to content

Commit 87adaf0

Browse files
committed
minor #14996 Add reference from CHANGELOG conventions to commit message conventions (wouterj)
This PR was merged into the 4.4 branch. Discussion ---------- Add reference from CHANGELOG conventions to commit message conventions As they are in different documents, I think adding a reference is a good idea. Commits ------- 25c0716 Add reference to commit message conventions
2 parents 6055971 + 25c0716 commit 87adaf0

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

contributing/code/conventions.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,9 @@ conventions:
9999

100100
* No third level sections are allowed;
101101

102-
* Messages should follow the commit message conventions: should be short,
103-
capitalize the line, do not end with a period, use an imperative verb to
104-
start the line;
102+
* Messages should follow the :ref:`commit message conventions <commit-messages>`:
103+
should be short, capitalize the line, do not end with a period, use an
104+
imperative verb to start the line;
105105

106106
* New entries must be added on top of the list.
107107

contributing/code/pull_requests.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,8 @@ in mind the following:
224224
* Never fix coding standards in some existing code as it makes the code review
225225
more difficult;
226226

227+
.. _commit-messages:
228+
227229
* Write good commit messages: Start by a short subject line (the first line),
228230
followed by a blank line and a more detailed description.
229231

0 commit comments

Comments
 (0)