[git-scm.com PATCH] community: advertise 'git-bugreport' tool

From: Emily Shaffer <emilyshaffer@google.com>
Date: May 28, 2020, 23:16 UTC
Message-ID: <20200528231608.59507-1-emilyshaffer@google.com>

Starting with 2.27.0, 'git bugreport' can gather diagnostic info and drop the user into an editor with a template for a useful bugreport. Advertise this feature to users who want to report a bug in Git.

Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
---

Hi all,

Since this patch deals with some prominent information about how to contact the community, I figured it was worth passing through the list for feedback rather than just sending a PR to the website repo. Discussion prior to this patch here: https://github.com/git/git-scm.com/issues/1464

In the index.html.erb diff I'm interested in wordsmithing feedback; this is the page which appears at https://git-scm.com/community. The diff in _debugging.html.erb is modifying the list of references in https://git-scm.com/docs - I'm interested in feedback on whether this is the best header to include git-bugreport under.

Thanks and sorry for the off-repo noise.

 - Emily

 app/views/community/index.html.erb       | 11 +++++++----
 app/views/shared/ref/_debugging.html.erb |  1 +
 2 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/app/views/community/index.html.erb b/app/views/community/index.html.erb
index 6927e19..bfcb089 100644
--- a/app/views/community/index.html.erb
+++ b/app/views/community/index.html.erb
@@ -36,10 +36,13 @@
 
   <p>
     Bugs in git can be reported directly to the mailing list (see above for
-    details). Note that you do not need to subscribe to the list to send
-    to it. You can help us out by attempting to reproduce the bug in the latest
-    released version of git, or if you're willing to build git from source, the
-    <a href="https://github.com/git/git/tree/next"><code>next</code> branch</a>.
+    details). Note that you do not need to subscribe to the list to send to it.
+    If you are using git 2.27.0 or later, you can run <code>git bugreport</code>,
+    which generates a template to guide you through writing a useful bug report
+    and gathers some diagnostic information about your environment. You can
+    help us out by attempting to reproduce the bug in the latest released
+    version of git, or if you're willing to build git from source, the
+    <a href="https:/break/github.com/git/git/tree/next"><code>next</code> branch</a>.
     Sometimes an attempted fix may be pending in this branch, in which case
     your feedback as to whether the fix worked for you will be appreciated.
   </p>
diff --git a/app/views/shared/ref/_debugging.html.erb b/app/views/shared/ref/_debugging.html.erb
index 286a690..4732b75 100644
--- a/app/views/shared/ref/_debugging.html.erb
+++ b/app/views/shared/ref/_debugging.html.erb
@@ -2,5 +2,6 @@
 <ul class='unstyled'>
   <li><%= man('git-bisect') %></li>
   <li><%= man('git-blame') %></li>
+  <li><%= man('git-bugreport') %></li>
   <li><%= man('git-grep') %></li>
 </ul>

-- 
2.27.0.rc0.183.gde8f92d652-goog