Custom Pull Request Description Template (BB-14637)

Issue #11571 open
Ben Tatham
created an issue

Lately, a bullet list of the commit messages has been added to the default description of a Pull Request.

This is great, but we'd love to have our own template, that might include some of this dynamic data, using some parameters like ${commits} or something.

We typically include multiple headings in all PRs for our team, and it would be nice to have that auto-populated.

Official response

  • Jarred Colli staff

    Hi Everyone,

    Thanks for your feedback on the issue of pull-request templates. Sorry to disappoint the many participants in this thread, but this specific project isn't on the roadmap yet. However, our team is spending a lot of time and energy on improving other aspects of pull requests, code search, and deployments.

    I will circle back on this again sometime soon.

    Sincerely, Jarred

Comments (93)

  1. Zachary Davis

    This is not currently on the roadmap, and as far as I know there isn't any current plan to add this functionality. This doesn't mean we never plan on doing it, or that we don't think it's a useful idea. It's just not at the top of our priorities right now.

  2. Marie Fetiveau

    Also interested by this feature. Our PR template is static, right now we are copying / pasting it from Confluence, but could be really helpful if it is already here in the description when we create the PR.

  3. WeiningMa

    We'd love to have this feature also. We are using a static PR template right now and every time people need to copy/paste.

    BTW: @Peter Ramsing, we have also tried the Chrome extension but it doesn't work though. Creating commit first then do PR but there is no template added into the PR... Any idea?

  4. Sravan Manne

    +1 We are looking forward for this feature as well. -To be able to define sort of a "Description Template" for the developers to provide some mandatory details while raising a PR.

  5. bartread

    +1 for this feature. -1 for the yak-shaving I had to go through to add a comment to it.

    Seriously, it's been incredibly useful with GitHub. I have, however, a client who uses on premise BitBucket and for whom GitHub isn't really an option (in theory they could migrate to on premise GitHub Enterprise, but it's kind of a pain in the neck). This feature would be incredibly useful for them as well.

    I've previously worked on teams where you can use it to include, for example, a checklist of actions to be completed/considered before submitting a PR, which can help make the code review and approval process run smoother.

  6. Manuel Gรณmez

    Ok, unsusbscribing after months of daily "+1"s and no f's given by BitBucket team.

    For this and other issues, my organization is moving to git and will use a more mature and user aware solution, as GitHub, Gitlab or whatever, anything will be better than this.

    Good luck!

  7. Chris Werding

    What I am wondering is why nobody (no staff) is managing this proactively? And it's not like we would be talking about some super scary special feature? This, along with BB-14755 is just so obviously useful that I am really wondering what's the issue here? Feature parity with Github would be SO important, dear Atlassian!

    Reminds me of Hipchat, a couple of years ago. Hipchat was ok, the integration with Jira was good, the client really bad (in it's early days). And instead of any progress, it just sat there and nothing happened. And then came Slack. And that was it, basically, for Hipchat.

    So dear Atlassian, how can we help? We would love to, really. Otherwise, we wouldn't be posting on your support forums all day long, right? :-)

    Best, .chris

  8. Val Redchenko

    I will use this when building an argument for my bosses of why we are ditching Bitbucket and taking our business to GitHub or set up a GitLab on AWS.

    A PR template is crucially important for forming good git habits amongst less experienced developers and is a feature that's easy to implement

  9. Andrรฉ Tito Vasconcelos

    You sir, are a lifesaver. The extension worked like a charm!

    For anyone else facing this issue, i highly recommend using this (make sure to activate features you need in Chrome://extensions after installing it from the store)

  10. Ronald Rey

    @Andrรฉ Tito Vasconcelos Thank you for pointing that out! I forgot to mention it and definitely some users miss that.

    Here's a GIF on the feature working, just to catch the attention of anyone skimming through this issue that might not have caught my previous message. In it I'm using the template hosted on https://gist.githubusercontent.com/anonymous/8054a3ee32f7cf1a5975e3fd52b3c5f3/raw/f6897720e8b6b93becd246187dac36038291c3a4/PULL_REQUEST_TEMPLATE.md, but it can also be part of the actual Bitbucket repository. The details of how it works is in the README of the extension here.

    pullrequest-template

  11. Paresh Mayani

    +100000000000000000 Come on Atlassian and Bitbucket team, listen to your customers what they are expecting and what other products Github/Gitlab are providing with which Bitbucket is lacking! Can you even believe it would take more than 3 years to implement this small set of functionality? Do you think it makes sense to keep 1000 of users in waiting list!

  12. Jarred Colli staff

    Hi Everyone,

    Thanks for your feedback on the issue of pull-request templates. Sorry to disappoint the many participants in this thread, but this specific project isn't on the roadmap yet. However, our team is spending a lot of time and energy on improving other aspects of pull requests, code search, and deployments.

    I will circle back on this again sometime soon.

    Sincerely, Jarred

  13. Anonymous

    @Jarred Colli so many users/teams that want this feature and github already has it - don't you think product people in Atlassian should reconsider ? roadmaps can change, I'm sure you guys are agile and are concerned about what's best for your customers!

    Cheers!

    P.S. Non- of the mentioned plugins is a good enough solution

  14. Jarred Colli staff

    Hey Nir! Its really a question of what work is already in progress that blocks other changes. Thanks for sharing that about the plugin, I'll allow others to make up their mind as to whether or not it works for them.

  15. Anonymous

    @Ronald Verhaegen Rey don't get me wrong - your plugin is cool, but for my needs it's not enough - I need APIs that I can integrate with so I'll be able to modify templates dynamically.

  16. Ronald Rey

    @nalfasi No offense taken, just wondering how it could be improved. I'm not sure what your needs are but it could probably be done through the plugin, I've just never had the feedback/request for it.

    As it stands now, for the rest of the people who don't need dynamic data in the template I believe it's a valid temporary solution.

  17. Log in to comment