[core-workflow] Choosing a prefix/label for issue numbers

[Brett Cannon]

On Wed, 1 Feb 2017 at 10:52 Ezio Melotti <ezio.melotti at gmail.com> wrote:

> +1 on bpo NNNN
> +0.5 on issue NNNN
> -0.5 on bug NNNN
>
> However I wonder if there's any way to change the automatic GitHub
> links, or at least disable them.  Even if we agree on a convention, it
> will take time to educate contributors, especially new or occasional
> ones (unless we have a way to put a disclaimer in a prominent place).
>
> I'm not too familiar with GitHub, but:
>   * can the link target be changed (i.e. from github.com to
> bugs.python.org)?
>

No


>   * can it be disabled?
>

No


>   * if the corresponding issue doesn't exist, will the link still be
> created?
>

No


>   * if it won't be created, will it link to PRs instead (once we have
> enough)?
>

PRs and issues are the same thing to GitHub in this instance.


>   * is there any mechanism (hooks/bots/etc) that allows us to convert
> #NNNN to an explicit link (i.e.
> [#NNNN](http://bugs.python.org/issueNNNN) )?
>

Not sure. I assume it will be overridden.


>   * if there is, can it be used on PR titles, PR messages, and commit
> messages?
>

Not titles, yes on messages.

-Brett


>
> Best Regards,
> Ezio Melotti
>
> On Wed, Feb 1, 2017 at 7:43 PM, Brett Cannon <brett at python.org> wrote:
> > Historically commit messages for CPython have had the form of "Issue
> #NNNN:
> > did something". The problem is that Github automatically links "#NNNN" to
> > GitHub issues (which includes pull requests). To prevent incorrect
> linking
> > we need to change how we reference issue numbers.
> >
> > The current candidates are:
> >
> >    issue NNNN (notice the lack of #)
> >
> >     bug NNNN
> >
> >     bpo NNNN ("bpo" stands for "bugs.python.org")
> >
> > Whatever choice we go with it will be how we reference issues in PR
> titles
> > and comments to link the PR to the issue, and in commit messages to send
> a
> > message to the issue about the commit.
> >
> > To start this off, I'm -1 on "issue" (because people will out of habit
> add
> > the #), +0 on "bug" (it's different but not everything is a bug), and +1
> on
> > "bpo" (as it namespaces our issues).
> >
> > _______________________________________________
> > core-workflow mailing list
> > core-workflow at python.org
> > https://mail.python.org/mailman/listinfo/core-workflow
> > This list is governed by the PSF Code of Conduct:
> > https://www.python.org/psf/codeofconduct
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/core-workflow/attachments/20170201/7f90c7b4/attachment-0001.html>