Forums

Articles
Create
cancel
Showing results for 
Search instead for 
Did you mean: 

Where is the documentation for the pull request template syntax?

Brian Hawley
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
April 17, 2025

My organization is insisting that we create a pull request default description.

https://confluence.atlassian.com/bbkb/pull-request-templates-in-bitbucket-cloud-1540228139.html says that you can create a pull request template using Markdown syntax. However, it doesn't say what features of Markdown is supported. Are any extensions supported, like code block language specifiers, etc? Since this is a template, are there any Bitbucket template specifiers to have it fill in with PR metadata?

Also, is the commit message for a PR added to the PR description before the default description? https://support.atlassian.com/bitbucket-cloud/kb/understanding-the-default-pull-request-title-description-and-merge-commit-message/ says the default behavior is to not have the commit message added as the description if there's one commit, but to add the messages if there are multiple commits. Does that behavior apply when you have a pull request template defined? Is there something we can add to the PR template to have it insert the commit message to the description?

Any more detailed documentation pages would be appreciated.

1 answer

0 votes
Ben
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
April 21, 2025

Hi @Brian Hawley 

As the PR template is an md file, it will support all the functionality of markdown that wiki supports - you can see the wiki documentation for markdown here:

If you include a PR template, it will simply have the static PR description inserted into the description field when you create a PR. There is no method for inserting the commit message into the description - and it will not do so when using the template:

  • I've raised a feature request on your behalf to allow this functionality, please feel free to Watch it to follow updates and Vote for it to improve its visibility with regard to customer demand:
    https://jira.atlassian.com/browse/BCLOUD-23674

Cheers!

- Ben (Bitbucket Cloud Support)

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
TAGS
AUG Leaders

Atlassian Community Events