Skip to content

Commit 099ddc5

Browse files
committed
Add section to PR guide on titles and descriptions
Add a short section to the PR guide which covers good titles and descriptions, at a summary level. The priority here is (in presentation order): - explain the rationale / why we care - demonstrate how a PR title should look - give some hint as to what a good description will look like Explaining how to write good technical prose for a PR description is considered out of scope, which limits the content of the PR description section.
1 parent 0164145 commit 099ddc5

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

getting-started/pull-request-lifecycle.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,24 @@ 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. It should start with ``gh-NNNNNN:``, for pull
214+
requests which close open issues.
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+
223+
206224
.. _news-entry:
207225
.. _what-s-new-and-news-entries:
208226

0 commit comments

Comments
 (0)