IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update commit message recommendations

Browse Source
This commit is contained in:
Adam Turner 2025-02-15 22:09:27 +00:00
parent 783884c0c8
commit 29a02c64e0
1 changed files with 6 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/internals/contributing.rst
View File

@ -121,16 +121,7 @@ These are the basic steps needed to start developing on Sphinx.
.. code-block:: shell
git commit -m '#42: Add useful new feature that does this.'
GitHub recognizes certain phrases that can be used to automatically
update the issue tracker. For example:
.. code-block:: shell
git commit -m 'Closes #42: Fix invalid markup in docstring of Foo.bar.'
would close issue #42.
git commit -m 'Add useful new feature that does this.'
#. Push changes in the branch to your forked repository on GitHub:
@ -140,6 +131,11 @@ These are the basic steps needed to start developing on Sphinx.
#. Submit a pull request from your branch to the ``master`` branch.
GitHub recognizes certain phrases that can be used to automatically
update the issue tracker.
For example, including 'Closes #42' in the body of your pull request
will close issue #42 if the PR is merged.
#. Wait for a core developer or contributor to review your changes.