Skip to content

Documentation about pull request template capabilities is incorrect/inconsistent #38761

Open
@serriere

Description

@serriere

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request

What part(s) of the article would you like to see updated?

This page on Using query parameters to create a pull request suggests that it's possible to create a pull request template that opens with default labels, assignees, and a pull request title:

> [!TIP]
> You can also create pull request templates that open with default labels, assignees, and a pull request title. For more information, see [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests).

But the primary page on Creating a pull request template for your repository makes no reference to being able to set default labels, assignees, or a pull request title. In fact, it appears to indicate that a pull request template only affects the pull request body.

You can create a _PULL_REQUEST_TEMPLATE/_ subdirectory in any of the supported folders to contain multiple pull request templates, and use the `template` query parameter to specify the template that will fill the pull request body. For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request).

I think the tip on Using query parameters to create a pull request should be updated to reflect the fact that pull request templates only affect the body of a pull request.

Additional information

That said, it would be great if pull request templates supported the exact same front matter as issue templates so the default pull request title could be configured. Our use case is that people just leave the default title, which is often something like Update README.md when we want them to spend the time to write a descriptive PR title.

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teampull requestsContent related to pull requests

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions