Skip to content

Commit 6c817a6

Browse files
freakboy3742hugovk
andauthored
Meta: Add a note about populating the PR from a template. (python#3474)
Co-authored-by: Hugo van Kemenade <[email protected]>
1 parent 6f1da20 commit 6c817a6

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

CONTRIBUTING.rst

+20-1
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,25 @@ a discussion venue appropriate to the PEP (such as `Typing Discourse
4242
typing, or `Packaging Discourse <https://discuss.python.org/c/packaging/>`__
4343
for packaging), or `open an issue <https://github.com/python/peps/issues>`__.
4444

45+
Opening a pull request
46+
----------------------
47+
48+
The PEPs repository defines a set of pull request templates, which should be
49+
used when opening a PR.
50+
51+
If you use Git from the command line, you may be accustomed to creating PRs
52+
by following the URL that is provided after pushing a new branch. **Do not use
53+
this link**, as it does not provide the option to populate the PR template.
54+
55+
However, you *can* use the ``gh`` command line tool. ``gh pr create`` will allow
56+
you to create a pull request, will prompt you for the template you wish to use,
57+
and then give you the option of continuing editing in your broswer.
58+
59+
Alternatively, after pushing your branch, you can visit
60+
`https://github.com/python/peps <https://github.com/python/peps>`__, and follow
61+
the link in the notification about recent changes to your branch to
62+
create a new PR. The in-browser interface will allow you to select a PR template
63+
for your new PR.
4564

4665
Commit messages and PR titles
4766
-----------------------------
@@ -56,7 +75,7 @@ the Readme/Contributing Guide, issue/PR template, etc., with ``Meta:``.
5675
Sign the Contributor License Agreement
5776
--------------------------------------
5877

59-
All contributors need to sign the
78+
All contributors need to sign the
6079
`PSF Contributor Agreement <https://www.python.org/psf/contrib/contrib-form/>`_.
6180
to ensure we legally accept your work.
6281

0 commit comments

Comments
 (0)