Skip to content

proposal: x/gopherbot: support GitHub references as full URLs #73320

@abitrolly

Description

@abitrolly

Proposal Details

GitHub issue reference parser doesn't support full URLs https://github.com/golang/build/blob/84dc9920c8ca7e489419403062832d2852738f8e/maintner/github.go#L2518.

Go guidelines https://go.dev/doc/contribute#ref_issues tell to use shorthand syntax.

The special notation "Fixes #12345" associates the change with issue 12345 in the Go issue tracker. When this change is eventually applied, the issue tracker will automatically mark the issue as fixed.
...
If you are sending a change against a golang.org/x/... repository, you must use the fully-qualified syntax supported by GitHub to make sure the change is linked to the issue in the main repository, not the x/ repository. Most issues are tracked in the main repository's issue tracker. The correct form is "Fixes #159".

While I enjoy commitOps, the simple from GitLab guidelines changed my perspective:

Use issues, milestones, and merge requests’ full URLs instead of short references, as they are displayed as plain text outside of GitLab.

https://docs.gitlab.com/development/contributing/merge_request_workflow/#commit-messages-guidelines

And to be honest in GitLab projects I am clicking full issue links in git log often enough to appreciate that they can be opened by my terminal.

EDIT: Another reason to support full URLs is that copy/pasting the full link is easier than cutting digits out of it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions