Skip to content

Commit cc60068

Browse files
committed
Move "good-pull-request-metadata" section down
Give this section a referenceable label, and place it in the "Submitting" section rather than "Writing good pull requests". Keep the content largely the same, but add a new trailing sentence to note that `#NNNNN` syntax can link issues. This replaces a note from "Submitting" that was mostly redundant with the new section.
1 parent 5e6548c commit cc60068

1 file changed

Lines changed: 23 additions & 20 deletions

File tree

getting-started/pull-request-lifecycle.rst

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -203,23 +203,6 @@ should do to help ensure that your pull request is accepted.
203203

204204
#. Proper :ref:`documentation <documenting>` additions/changes should be included.
205205

206-
Write good titles and descriptions
207-
----------------------------------
208-
209-
Reviewers want to be able to understand roughly what your pull request does
210-
before reading the changes.
211-
212-
The title should be a sentence or phrase in the imperative which says what the
213-
pull request does in short form. Pull requests attached to issues should
214-
be linked by putting the issue number in the title (``gh-NNNNNN:``).
215-
For example, ``gh-12345: Fix bug when spam module is served with eggs``.
216-
217-
The pull request description field should be a detailed summary.
218-
This is a great place to note caveats, provide links to references, and explain
219-
decisions made in the pull request.
220-
Avoid over-explaining: simpler descriptions are easier to read, so make sure not
221-
to write large descriptions for simple changes.
222-
223206

224207
.. _news-entry:
225208
.. _what-s-new-and-news-entries:
@@ -521,9 +504,7 @@ This will get your changes up to GitHub.
521504
Now you want to
522505
`create a pull request from your fork
523506
<https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork>`__.
524-
If this is a pull request in response to a pre-existing issue on the
525-
`issue tracker`_, please make sure to reference the issue number using
526-
``gh-NNNNN:`` prefix in the pull request title and ``#NNNNN`` in the description.
507+
See :ref:`the section below on writing good titles and descriptions <good-pull-request-metadata>`.
527508

528509
If this is a pull request for an unreported issue (assuming you already
529510
performed a search on the issue tracker for a pre-existing issue), create a
@@ -543,6 +524,28 @@ A detailed commit history allows reviewers to view the diff of one commit to
543524
another so they can easily verify whether their comments have been addressed.
544525
The commits will be squashed when the pull request is merged.
545526

527+
.. _good-pull-request-metadata:
528+
529+
Write good titles and descriptions
530+
----------------------------------
531+
532+
Reviewers want to be able to understand roughly what your pull request does
533+
before reading the changes.
534+
535+
The title should be a sentence or phrase in the imperative which says what the
536+
pull request does in short form.
537+
Pull requests attached to issues should be linked by putting the issue number in
538+
the title (``gh-NNNNNN:``).
539+
For example, ``gh-12345: Fix bug when spam module is served with eggs``.
540+
541+
The pull request description field should be a detailed summary.
542+
This is a great place to note caveats, provide links to references, and explain
543+
decisions made in the pull request.
544+
Avoid over-explaining: simpler descriptions are easier to read, so make sure not
545+
to write large descriptions for simple changes.
546+
547+
Use ``#NNNNN`` in the description to refer to and link relevant issues.
548+
546549

547550
Converting an existing patch from b.p.o to GitHub
548551
=================================================

0 commit comments

Comments
 (0)