Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

x/website: add bug filing wizard #11695

Open
bradfitz opened this issue Jul 13, 2015 · 14 comments
Open

x/website: add bug filing wizard #11695

bradfitz opened this issue Jul 13, 2015 · 14 comments

Comments

@bradfitz
Copy link
Contributor

@adg and I were discussing putting a little web app up in front of Github's actual issue tracker, to get better bug reports from users.

The old code.google.com bug tracker let us present different types of users (project owners/developers vs. users) different types of templates. Github has nothing. As a result, we get some pretty incomplete bug reports.

Proposal:

  • https://golang.org/issue/new and various other things would link or redirect to a new web app, e.g. https://bug.golang.org/
  • https://bug.golang.org/ would take the user through an auth flow to get their Github auth token with permission to file a bug.
  • https://bug.golang.org/ would then have users fill out a template form, asking the Go questions (version, OS/ARCH, go env, etc) which would help us debug.
  • upon submit, we post a bug to Github as the original Github user. (Bugs aren't posted as a robot account)
  • a bot would find bugs filed directly to Github without using the template and amend them with a hint to use the bug instead. Perhaps we even link to https://bug.golang.org/amend/NNNN where NNN is the incomplete bug report. We could then append to the bug with the details. The bot would not trigger for bugs filed by members of the project.

@adg also proposed baking some bug-filing capabilities into the go command, but the details of that are fuzzy and would be the subject of a separate bug. Let's not discuss that part here.

/cc @robpike @rsc

@bradfitz bradfitz added this to the Unplanned milestone Jul 13, 2015
@adg
Copy link
Contributor

adg commented Jul 14, 2015

The front end could also use some kind of matching algorithm to find
potential pre-existing bugs.

On 13 July 2015 at 11:23, Brad Fitzpatrick notifications@github.com wrote:

@adg https://github.com/adg and I were discussing putting a little web
app up in front of Github's actual issue tracker, to get better bug reports
from users.

The old code.google.com bug tracker let us present different types of
users (project owners/developers vs. users) different types of templates.
Github has nothing. As a result, we get some pretty incomplete bug reports.

Proposal:

  • https://golang.org/issue/new and various other things would link or
    redirect to a new web app, e.g. https://bug.golang.org/
  • https://bug.golang.org/ would take the user through an auth flow to
    get their Github auth token with permission to file a bug.
  • https://bug.golang.org/ would then have users fill out a template
    form, asking the Go questions (version, OS/ARCH, go env, etc) which would
    help us debug.
  • upon submit, we post a bug to Github as the original Github user.
    (Bugs aren't posted as a robot account)
  • a bot would find bugs filed directly to Github without using the
    template and amend them with a hint to use the bug instead. Perhaps we even
    link to https://bug.golang.org/amend/NNNN where NNN is the incomplete
    bug report. We could then append to the bug with the details. The bot would
    not trigger for bugs filed by members of the project.

@adg https://github.com/adg also proposed baking some bug-filing
capabilities into the go command, but the details of that are fuzzy and
would be the subject of a separate bug. Let's not discuss that part here.

/cc @robpike https://github.com/robpike @rsc https://github.com/rsc


Reply to this email directly or view it on GitHub
#11695.

@josharian
Copy link
Contributor

This sounds great. The front end could also guide users to ask questions on golang-nuts instead of filing issues. (The bot that finds bugs filed directly to GitHub should probably also provide that hint.)

@rsc
Copy link
Contributor

rsc commented Oct 24, 2015

This seems like an obviously good idea. Go for it. (Make sure the app only asks for public_repo.)

@rsc rsc changed the title proposal: add bug filing wizard website: add bug filing wizard Oct 24, 2015
@broady
Copy link
Member

broady commented Jun 27, 2016

Is this something we still want? Since October, we got GitHub issue templates.

@bradfitz
Copy link
Contributor Author

I think it could still be helpful.

@adg
Copy link
Contributor

adg commented Jun 27, 2016

I think it would still be a nice thing to have.

On 28 June 2016 at 08:36, Chris Broadfoot notifications@github.com wrote:

Is this something we still want? Since October, we got GitHub issue
templates.


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#11695 (comment), or mute
the thread
https://github.com/notifications/unsubscribe/AIDilU-AhYtSyDH6MBjN3b5HRZChviW1ks5qQFBwgaJpZM4FXneO
.

@adg
Copy link
Contributor

adg commented Jul 19, 2016

If someone wants to tackle this, go ahead.

@SCKelemen
Copy link
Contributor

@adg Is this issue, and #16635 something we still want to pursue? I could work on this in October?

@rsc
Copy link
Contributor

rsc commented Sep 28, 2017

@andybons would be the person to talk to at this point.

It seems to me that the combination of github issue templates and go bug (new since the Jul 19, 2016 "go ahead" comment) greatly reduces the benefit of a whole separate web page. At this point the incremental benefit seems not clearly greater than the cost of implementation and ongoing maintenance. I'd even be OK with closing this issue at this point. Effort on tools might be better spent on others, like the PR gateway.

Leaving for @andybons

@SCKelemen
Copy link
Contributor

Is there a PR Gateway Issue I should review, and potentially work on, instead?

@andybons
Copy link
Member

@SCKelemen the relevant issue for PR to Gerrit import is #18517. I’m working on an initial design document for that. Will update the bug with that once it’s in a good state.

@ysmolski
Copy link
Member

@andybons is this ticket is going to be abandoned?

@andybons
Copy link
Member

Not at the moment, no. There are questions I have about discoverability, though. How would we get people to actually use it? Can the current issues with bug reports be solved with more automation like gopherbot?

I’m also going to echo Russ’s comment about the incremental benefit. We have a lot on our plate so we can’t guarantee that the Go team at Google would take ownership should it be built.

If someone wants to start on a design for this, we are happy to consult, but I would outline the work to be done in this bug (or a google doc) before moving forward.

We built GerritBot to meet users where they were (GitHub PRs over Gerrit for CL creation). Building a tool to move them away from here for bugs seems like the opposite direction to take.

Please excuse my rambling. I think you get the gist of what I’m saying, though :)

@odeke-em
Copy link
Member

odeke-em commented Oct 2, 2019

Given that Github now has:

  • templates, which we actively use (they weren't available in 2015 when this issue was created) https://github.com/golang/go/blob/master/.github/ISSUE_TEMPLATE
  • auto complete suggesting similar issues based on lexicographic matches, as an issue is typed
  • GerritBot to port Github PRs to CLs
  • Gopherbot for automation and testing
  • Github actions that are upcoming

perhaps let's revisit if we need to anything more here or rather leaving any remaining work to Github to implement.

@seankhliao seankhliao changed the title website: add bug filing wizard x/website: add bug filing wizard Mar 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests