go bug

[Josh Bleecher Snyder]

CL 28485 added a 'go bug' subcommand. The goal is to get better, more
complete information with initial bug reports.

I'd like to start getting some miles on it, but we can't update the
issue template to ask reporters to use it, since it is not yet
released.

If you're reading this list, you probably use tip. If you would,
please start using 'go bug' instead of 'go env' when filing issues.
And yes, please file helpful bugs about the bug filing helper. :)

Thanks!

-josh

[Rob Pike]

I think what "go bug" prints is helpful but the command is misnamed and insufficiently documented.

I would expect that something called "go bug" would handle the issue tracker, for instance that

  go bug 1234

will print something about issue 1234. Perhaps

  go bug new

would help me file a bug directly Instead, it just dumps some environment variables. Worse, what's there doesn't even complain that it has an argument it will ignore: "go bug 1234" prints the same output as "go bug".

What's there now is an environment dump. "Go env" is taken, but some evocative name would improve it. A better solution is probably that "go env" is adapted to do this, maybe

  go env -bug

or, better,

  go env -issue

since issue is our public word, not bug.

The documentation doesn't say how to use it or what it's really for or why it exists.

-rob

-josh

--
You received this message because you are subscribed to the Google Groups "golang-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to golang-dev+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Quentin Smith]

"go bug" makes sense to me, moreso than "go env -bug" or "go env -issue". However, it certainly could be cleaned up - even if it just printed something that said "Please go to golang.org/issue and paste in the following output: <...>"

--Quentin

[Rob Pike]

Why does "go bug" make sense to you? How does it evoke cut-and-paste, that the output is a set of environment variables, and that it is in GitHub markdown format?

-rob

[Quentin Smith]

It doesn't evoke any of those things for me. The first, I am saying it should explicitly say. The latter two, though, the user doesn't even need to know or care about. The info is for us, the Go developers, not the user.

It makes sense to me because there are already several other tools I am familiar with that have similar bug report commands. ("adb bugreport", "reportbug", bug.report() in R, "ubuntu-bug", etc.)

--Quentin

[Robert Griesemer]

I agree with Rob's criticism - it's odd the go bug essentially is a glorified go env - why not use go env (or extend that)?

- gri

[Rob Pike]

If it were a bug reporting command, I would agree with the name. But it's not, it's just an environment dump.

-rob

[Brad Fitzpatrick]

I thought I recalled opposition towards extending go env, since people source that in shells to popular environment variables, and we want to dump things which aren't shell syntax.

Besides, this is supposed to be a tool for filing bugs. It only looks like "go env" at this point.

Eventually we want to dump Markdown for copy/paste into Github, or even just open a pre-filled https://github.com/golang/go/issues/new page, ready for them to click.

[Rob Pike]

If it opened my browser to a pre-loaded bug after prompting for details and checking for correct formatting, "go bug" would be a fine name.

As it stands, though, it's just an undocumented wart.

-rob

[Brad Fitzpatrick]

We can remove it if it doesn't mature before the release.

[minux]

On Sep 6, 2016 6:00 PM, "Rob Pike" <r...@golang.org> wrote:
>
> If it opened my browser to a pre-loaded bug after prompting for details and checking for correct formatting, "go bug" would be a fine name.

I like this idea. We should make go bug open a browser window with pre-filled environment information.

Github support that and we use it in the report bug button in the Go tour.

[Josh Bleecher Snyder]

>> If it opened my browser to a pre-loaded bug after prompting for details
>> and checking for correct formatting, "go bug" would be a fine name.
>
> I like this idea. We should make go bug open a browser window with
> pre-filled environment information.
>
> Github support that and we use it in the report bug button in the Go tour.

SGTM. I'll mail a CL.

[Josh Bleecher Snyder]

https://go-review.googlesource.com/c/29210/

I expect there'll be more iteration yet.