Pull Request description message template | Voters

Pull Request description message template

David Labra Gaona

Similar to the Branch name template, provide an option to modify the description message used for when the pull requests are created with the Git Integration for Jira add-on.

February 29, 2024

Eric Palmitesta

John Nelson ok, thanks! One other scenario we've come across is the message defaults to e.g. "DIS-3530: Merge foo/bar/baz to main" but some time later the PR is re-targeted to merge into another branch (say

dev

instead of

main

), at that point the PR title becomes incorrect unless manually fixed (should be "DIS-3530: Merge foo/bar/baz to dev"). Ideally I'd rather not reference the source/destination branches at all, the PR title (which most of the time is the Jira issue title) is really what matters to me/us.

John Nelson

Eric Palmitesta That makes sense. The way we'd probably approach it is similar to that of the branch name templates, in which you'd be able to use variables like ${issuetype}, ${issuekey}, ${summary}, etc. to construct your template. The intent is that you and your team would be able to include only what's important to you with the aim of minimizing customization on creation.

John Nelson

@Eric Palmitesta, thanks for the feedback. This is one the team will be discussing in the near future.

Eric Palmitesta

Seconding this, the default PR title is something like "DIS-3530: Merge users/myname/main/DIS-3530-2fa-authentication-via-sms to main" which we rename to the Jira issue title (or something close to it) every time, something like "DIS-3530: 2FA authentication via SMS". We find this much more descriptive and easier to read when looking through merged PRs. The branch name can be found by opening the PR if needed, and after the branch is merged the branch is deleted anyways, so having the branch name in the PR title doesn't have much value to us.