{"thread":{"id":"53576","subject":"[git-scm.com PATCH] community: advertise 'git-bugreport' tool","startedAt":"2020-05-28T23:16:24Z","lastAt":"2020-05-29T03:37:43Z","messageCount":8,"participants":["Emily Shaffer","Junio C Hamano","Jonathan Nieder","Philippe Blain","Jeff King"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"398813","messageId":"20200528231608.59507-1-emilyshaffer@google.com","threadId":"53576","inReplyTo":null,"subject":"[git-scm.com PATCH] community: advertise 'git-bugreport' tool","fromName":"Emily Shaffer","fromEmail":"emilyshaffer@google.com","sentAt":"2020-05-28T23:16:08Z","receivedAt":"2020-05-28T23:16:24Z","isPatch":true,"sender":{"key":"nasamuffin@google.com","avatar":"https://avatars.githubusercontent.com/u/1606826?v=4"},"body":"Starting with 2.27.0, 'git bugreport' can gather diagnostic info and\ndrop the user into an editor with a template for a useful bugreport.\nAdvertise this feature to users who want to report a bug in Git.\n\nSigned-off-by: Emily Shaffer \n---\n\nHi all,\n\nSince this patch deals with some prominent information about how to\ncontact the community, I figured it was worth passing through the list\nfor feedback rather than just sending a PR to the website repo.\nDiscussion prior to this patch here:\nhttps://github.com/git/git-scm.com/issues/1464\n\nIn the index.html.erb diff I'm interested in wordsmithing feedback; this\nis the page which appears at https://git-scm.com/community. The diff in\n_debugging.html.erb is modifying the list of references in\nhttps://git-scm.com/docs - I'm interested in feedback on whether this is\nthe best header to include git-bugreport under.\n\nThanks and sorry for the off-repo noise.\n\n - Emily\n\n app/views/community/index.html.erb | 11 +++++++----\n app/views/shared/ref/_debugging.html.erb | 1 +\n 2 files changed, 8 insertions(+), 4 deletions(-)\n\ndiff --git a/app/views/community/index.html.erb b/app/views/community/index.html.erb\nindex 6927e19..bfcb089 100644\n--- a/app/views/community/index.html.erb\n+++ b/app/views/community/index.html.erb\n@@ -36,10 +36,13 @@\n \n

\n Bugs in git can be reported directly to the mailing list (see above for\n- details). Note that you do not need to subscribe to the list to send\n- to it. You can help us out by attempting to reproduce the bug in the latest\n- released version of git, or if you're willing to build git from source, the\n- next branch.\n+ details). Note that you do not need to subscribe to the list to send to it.\n+ If you are using git 2.27.0 or later, you can run git bugreport,\n+ which generates a template to guide you through writing a useful bug report\n+ and gathers some diagnostic information about your environment. You can\n+ help us out by attempting to reproduce the bug in the latest released\n+ version of git, or if you're willing to build git from source, the\n+ next branch.\n Sometimes an attempted fix may be pending in this branch, in which case\n your feedback as to whether the fix worked for you will be appreciated.\n

\ndiff --git a/app/views/shared/ref/_debugging.html.erb b/app/views/shared/ref/_debugging.html.erb\nindex 286a690..4732b75 100644\n--- a/app/views/shared/ref/_debugging.html.erb\n+++ b/app/views/shared/ref/_debugging.html.erb\n@@ -2,5 +2,6 @@\n \n-- \n2.27.0.rc0.183.gde8f92d652-goog\n\n"},{"id":"398816","messageId":"xmqqftbj1vpf.fsf@gitster.c.googlers.com","threadId":"53576","inReplyTo":"20200528231608.59507-1-emilyshaffer@google.com","subject":"Re: [git-scm.com PATCH] community: advertise 'git-bugreport' tool","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2020-05-28T23:33:16Z","receivedAt":"2020-05-28T23:39:10Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Emily Shaffer writes:\n\n>

\n> Bugs in git can be reported directly to the mailing list (see above for\n> - details). Note that you do not need to subscribe to the list to send\n> - to it. You can help us out by attempting to reproduce the bug in the latest\n> - released version of git, or if you're willing to build git from source, the\n> - next branch.\n> + details). Note that you do not need to subscribe to the list to send to it.\n> + If you are using git 2.27.0 or later, you can run git bugreport,\n> + which generates a template to guide you through writing a useful bug report\n> + and gathers some diagnostic information about your environment. You can\n> + help us out by attempting to reproduce the bug in the latest released\n> + version of git, or if you're willing to build git from source, the\n> + next branch.\n\nIt took me a bit more then necessary to spot this due to rewrapping\nof the string, but I do not think you meant \"https:/break/\" there.\n\nCare to share how it happened (what tool has the tendency to\nintroduce this particular breakage)?\n\nThanks.\n"},{"id":"398818","messageId":"20200528235330.GA148632@google.com","threadId":"53576","inReplyTo":"xmqqftbj1vpf.fsf@gitster.c.googlers.com","subject":"Re: [git-scm.com PATCH] community: advertise 'git-bugreport' tool","fromName":"Emily Shaffer","fromEmail":"emilyshaffer@google.com","sentAt":"2020-05-28T23:53:30Z","receivedAt":"2020-05-28T23:53:43Z","isPatch":true,"sender":{"key":"nasamuffin@google.com","avatar":"https://avatars.githubusercontent.com/u/1606826?v=4"},"body":"On Thu, May 28, 2020 at 04:33:16PM -0700, Junio C Hamano wrote:\n> \n> Emily Shaffer writes:\n> \n> >

\n> > Bugs in git can be reported directly to the mailing list (see above for\n> > - details). Note that you do not need to subscribe to the list to send\n> > - to it. You can help us out by attempting to reproduce the bug in the latest\n> > - released version of git, or if you're willing to build git from source, the\n> > - next branch.\n> > + details). Note that you do not need to subscribe to the list to send to it.\n> > + If you are using git 2.27.0 or later, you can run git bugreport,\n> > + which generates a template to guide you through writing a useful bug report\n> > + and gathers some diagnostic information about your environment. You can\n> > + help us out by attempting to reproduce the bug in the latest released\n> > + version of git, or if you're willing to build git from source, the\n> > + next branch.\n> \n> It took me a bit more then necessary to spot this due to rewrapping\n> of the string, but I do not think you meant \"https:/break/\" there.\n> \n> Care to share how it happened (what tool has the tendency to\n> introduce this particular breakage)?\n\nYes, I noticed it late. I have no idea how it happened - I imagine I\nleaned on my touchpad (middle mouse paste) while typing or otherwise\nmashed some keys in Vim. In other words, the tool was me :) Have fixed\nit locally, thanks for spying it.\n\n - Emily\n"},{"id":"398821","messageId":"20200529002757.GD114915@google.com","threadId":"53576","inReplyTo":"20200528231608.59507-1-emilyshaffer@google.com","subject":"Re: [git-scm.com PATCH] community: advertise 'git-bugreport' tool","fromName":"Jonathan Nieder","fromEmail":"jrnieder@gmail.com","sentAt":"2020-05-29T00:27:57Z","receivedAt":"2020-05-29T00:28:03Z","isPatch":true,"sender":{"key":"jrnieder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/281595?v=4"},"body":"Emily Shaffer wrote:\n\n> Starting with 2.27.0, 'git bugreport' can gather diagnostic info and\n> drop the user into an editor with a template for a useful bugreport.\n> Advertise this feature to users who want to report a bug in Git.\n>\n> Signed-off-by: Emily Shaffer \n> ---\n> app/views/community/index.html.erb | 11 +++++++----\n\nModulo the link issue that Junio mentioned, LGTM. I think the section\non the page you chose is a good place to mention the command.\n\n> --- a/app/views/shared/ref/_debugging.html.erb\n> +++ b/app/views/shared/ref/_debugging.html.erb\n> @@ -2,5 +2,6 @@\n>

\n\nWhere does this show up on the rendered page? Is it\nhttps://git-scm.com/book/en/v2/Appendix-C:-Git-Commands-Debugging?\nIs there a way to preview how it renders?\n\nThat page appears to be about commands used to debug your own\ncodebase, so for everyone except us Git developers, it's the wrong\nplace to mention git bugreport. ;-)\n\nWithin the book, I think\nhttps://git-scm.com/book/en/v2/Getting-Started-Getting-Help and the\ncorresponding\nhttps://git-scm.com/book/en/v2/Appendix-C%3A-Git-Commands-Setup-and-Config\npage might make sense.\n\nThanks,\nJonathan\n"},{"id":"398827","messageId":"83936F1F-BFA8-4F74-8C24-07D42B1A044C@gmail.com","threadId":"53576","inReplyTo":"20200528231608.59507-1-emilyshaffer@google.com","subject":"Re: [git-scm.com PATCH] community: advertise 'git-bugreport' tool","fromName":"Philippe Blain","fromEmail":"levraiphilippeblain@gmail.com","sentAt":"2020-05-29T01:49:51Z","receivedAt":"2020-05-29T01:50:00Z","isPatch":true,"sender":{"key":"levraiphilippeblain@gmail.com","avatar":"https://avatars.githubusercontent.com/u/44212482?v=4"},"body":"Hi Emily,\n\n> Le 28 mai 2020 à 19:16, Emily Shaffer a écrit :\n> \n> Starting with 2.27.0, 'git bugreport' can gather diagnostic info and\n> drop the user into an editor with a template for a useful bugreport.\n> Advertise this feature to users who want to report a bug in Git.\n> \n> Signed-off-by: Emily Shaffer \n> ---\n> \n> Hi all,\n> \n> Since this patch deals with some prominent information about how to\n> contact the community, I figured it was worth passing through the list\n> for feedback rather than just sending a PR to the website repo.\n> Discussion prior to this patch here:\n> https://github.com/git/git-scm.com/issues/1464\n> \n> In the index.html.erb diff I'm interested in wordsmithing feedback; this\n> is the page which appears at https://git-scm.com/community. The diff in\n> _debugging.html.erb is modifying the list of references in\n> https://git-scm.com/docs - I'm interested in feedback on whether this is\n> the best header to include git-bugreport under.\n\nI think maybe `app/views/shared/ref/_setup.html.erb` would be a better fit ?\nThat's the section at the top of the page, with `git`, `help` and `config`, called\n\"Setup and Config\"... \n\nThe wording on the community page looks good.\n\nThanks,\n\nPhilippe."},{"id":"398829","messageId":"20200529032454.GB1271617@coredump.intra.peff.net","threadId":"53576","inReplyTo":"20200529002757.GD114915@google.com","subject":"Re: [git-scm.com PATCH] community: advertise 'git-bugreport' tool","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2020-05-29T03:24:54Z","receivedAt":"2020-05-29T03:24:58Z","isPatch":true,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Thu, May 28, 2020 at 05:27:57PM -0700, Jonathan Nieder wrote:\n\n> > --- a/app/views/shared/ref/_debugging.html.erb\n> > +++ b/app/views/shared/ref/_debugging.html.erb\n> > @@ -2,5 +2,6 @@\n> >
    \n> >
  • <%= man('git-bisect') %>
    • \n> >
  • <%= man('git-blame') %>
    • \n> > +
  • <%= man('git-bugreport') %>
    • \n> >
  • <%= man('git-grep') %>
    • \n> >
\n> \n> Where does this show up on the rendered page? Is it\n> https://git-scm.com/book/en/v2/Appendix-C:-Git-Commands-Debugging?\n\nNo, it's in the command-list in:\n\n https://git-scm.com/docs\n\nin the section \"debugging\".\n\n> Is there a way to preview how it renders?\n\nYes. :) You can clone the repo and build using the instructions in the\nREADME (including importing at least one version's worth of manpages to\nrender). It's a minor-ish pain to do so if you're not used to working\nwith Ruby or Rails.\n\nWe also spin up a staging deploy for any PRs opened against that repo,\nthough I _think_ it won't do so for PRs opened from another fork (since\nit can read the production database; we don't care for our project,\nwhich contains no secrets, but many projects would).\n\n-Peff\n"},{"id":"398830","messageId":"20200529033344.GC1271617@coredump.intra.peff.net","threadId":"53576","inReplyTo":"83936F1F-BFA8-4F74-8C24-07D42B1A044C@gmail.com","subject":"Re: [git-scm.com PATCH] community: advertise 'git-bugreport' tool","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2020-05-29T03:33:44Z","receivedAt":"2020-05-29T03:33:48Z","isPatch":true,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Thu, May 28, 2020 at 09:49:51PM -0400, Philippe Blain wrote:\n\n> > In the index.html.erb diff I'm interested in wordsmithing feedback; this\n> > is the page which appears at https://git-scm.com/community. The diff in\n> > _debugging.html.erb is modifying the list of references in\n> > https://git-scm.com/docs - I'm interested in feedback on whether this is\n> > the best header to include git-bugreport under.\n> \n> I think maybe `app/views/shared/ref/_setup.html.erb` would be a better fit ?\n> That's the section at the top of the page, with `git`, `help` and `config`, called\n> \"Setup and Config\"... \n\nGood suggestion. Most of \"debugging\" is about debugging your own code.\nAnd I think it's good to have this up near the top, where people are\nmore likely to stumble into it while trying to figure out how to report\na bug. :)\n\n-Peff\n"},{"id":"398831","messageId":"20200529033740.GD1271617@coredump.intra.peff.net","threadId":"53576","inReplyTo":"20200528231608.59507-1-emilyshaffer@google.com","subject":"Re: [git-scm.com PATCH] community: advertise 'git-bugreport' tool","fromName":"Jeff King","fromEmail":"peff@peff.net","sentAt":"2020-05-29T03:37:40Z","receivedAt":"2020-05-29T03:37:43Z","isPatch":true,"sender":{"key":"peff@peff.net","avatar":"https://avatars.githubusercontent.com/u/45925?v=4"},"body":"On Thu, May 28, 2020 at 04:16:08PM -0700, Emily Shaffer wrote:\n\n> Since this patch deals with some prominent information about how to\n> contact the community, I figured it was worth passing through the list\n> for feedback rather than just sending a PR to the website repo.\n> Discussion prior to this patch here:\n> https://github.com/git/git-scm.com/issues/1464\n\nThanks for doing that. I'd echo my sentiment in that issue that if\nanybody from list community is interested in suggesting changes to the\nCommunity page, we're happy to take patches. The bug-reporting advice\nthere has been slowly added over the years, and fresh eyes may produce\nuseful insights.\n\n> diff --git a/app/views/community/index.html.erb b/app/views/community/index.html.erb\n> index 6927e19..bfcb089 100644\n> --- a/app/views/community/index.html.erb\n> +++ b/app/views/community/index.html.erb\n> @@ -36,10 +36,13 @@\n> \n>

\n> Bugs in git can be reported directly to the mailing list (see above for\n> - details). Note that you do not need to subscribe to the list to send\n> - to it. You can help us out by attempting to reproduce the bug in the latest\n> - released version of git, or if you're willing to build git from source, the\n> - next branch.\n> + details). Note that you do not need to subscribe to the list to send to it.\n> + If you are using git 2.27.0 or later, you can run git bugreport,\n\nPerhaps make this a link to /docs/git-bugreport? That's not active yet,\nbut will be when we release v2.27 (scheduled for Monday). We could hold\nthis patch until then.\n\nOther than that, looks good to me, modulo the /break/ thing mentioned\nelsewhere.\n\n-Peff\n"}]}