Skip to content

Commit 29a02c6

Browse files
committed
Update commit message recommendations
1 parent 783884c commit 29a02c6

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

doc/internals/contributing.rst

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -121,16 +121,7 @@ These are the basic steps needed to start developing on Sphinx.
121121

122122
.. code-block:: shell
123123
124-
git commit -m '#42: Add useful new feature that does this.'
125-
126-
GitHub recognizes certain phrases that can be used to automatically
127-
update the issue tracker. For example:
128-
129-
.. code-block:: shell
130-
131-
git commit -m 'Closes #42: Fix invalid markup in docstring of Foo.bar.'
132-
133-
would close issue #42.
124+
git commit -m 'Add useful new feature that does this.'
134125
135126
#. Push changes in the branch to your forked repository on GitHub:
136127

@@ -140,6 +131,11 @@ These are the basic steps needed to start developing on Sphinx.
140131
141132
#. Submit a pull request from your branch to the ``master`` branch.
142133

134+
GitHub recognizes certain phrases that can be used to automatically
135+
update the issue tracker.
136+
For example, including 'Closes #42' in the body of your pull request
137+
will close issue #42 if the PR is merged.
138+
143139
#. Wait for a core developer or contributor to review your changes.
144140

145141

0 commit comments

Comments
 (0)