[outdooracorn]

Check PR description for a Phabricator task Git trailer in the format expected by the community commit message guidelines (Bug: T####)1

Bug: T443397

[github-actions]

@outdooracorn, please add any related Phabricator tasks as git trailers at the end of the PR description, separated from the text by a blank line.

For example (replace the example task IDs with your related tasks):

Example PR description text

Bug: T12345
Bug: T67890

You can also create a new task with the same title and description as this PR using the link below, then add its task ID as a Bug: trailer:

• Create task in the "Waiting for Peer Review" column

[deer-wmde]

I'm still a bit curious why we'd do the "Bug: " notation instead of a plain link

[outdooracorn]

I'm still a bit curious why we'd do the "Bug: " notation instead of a plain link

The main reason for me is that it follows the commit message guidelines of the movement:

• https://www.mediawiki.org/wiki/Gerrit/Commit_message_guidelines
• https://wikitech.wikimedia.org/wiki/GitLab/Webhooks#Phabricator
• https://www.mediawiki.org/wiki/Commit-message-validator

I don't think we should do something different to what the rest of the community is expecting as it will likely mean we we won't be able to make use of existing tools / scripts / services / libraries / etc. that expect this format, especially if we want to move our repos over to one of the WMF hosted git forge. For example, the wmde-github-phab-bot we use to comment on a Phabricator tasks when a PR is opened.

I don't know the exact reason why the "T####" ID was chosen over the URL but some plausible reasons that come to mind:

• The URL might change (e.g. if it is renamed from https://phabricator.wikimedia.org to https://phorge.wikimedia.org now that the upstream Phabricator project has stopped development).
• It might be easier for bots / scripts to use the "T####" ID rather than the URL. It's probably easier to do URL + "T####" ID over extracting the "T####" ID from a URL.
• According to this reply from Krinkle, there is "a long standing tradition in software development to refer to tickets and issues by ID" and desire to support/maintain a single pattern.
• The "T####" ID is easier to type.

---

How come you would rather use URLs over the "T####" ID?

There are settings and plugins for IDEs that allow you to define the mapping between "T####" ID and URL.
It's a shame that our wbstack org doesn't have the same tier of GitHub as the wmde org that allows for us to make "T####" IDs render as links in the GitHub UI. We could move our repos over to the wmde org, but if we are going through the effort of moving, it's probably better to just move straight to whichever non-GitHub forge we want to use long-term.

[deer-wmde]

There are settings and plugins for IDEs that allow you to define the mapping between "T####" ID and URL.

And a link just works, anywhere.

It's a shame that our wbstack org doesn't have the same tier of GitHub as the wmde org

Then it still would be dependent on a GitHub feature.

there is "a long standing tradition in software development to refer to tickets and issues by ID"

Right, and if we would use GitHub for our tasks or Phabricator for our code, this would work well. That's what we keep working around.