Skip to content

Commit b3ec84b

Browse files
DOC: note that PR titles should use the commit message prefix convention
The commit message prefix table (BUG, ENH, DOC, etc.) is well documented, but there is no mention that PR titles should follow the same convention. In practice this is required by the automated label mapping in .github/pr-prefix-labeler.yml. Add a short note in the "Asking for your changes to be merged" section so contributors know up front.
1 parent 8f8bbcb commit b3ec84b

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

doc/source/dev/development_workflow.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,10 @@ function, add a release note to the ``doc/release/upcoming_changes/``
269269
directory, following the instructions and format in the
270270
``doc/release/upcoming_changes/README.rst`` file.
271271

272+
Use the same prefix convention for your pull request title as for commit
273+
messages (e.g., ``BUG:``, ``ENH:``, ``DOC:``). This enables automated labeling
274+
of your PR.
275+
272276

273277
.. _workflow_PR_timeline:
274278

0 commit comments

Comments
 (0)