doc: Add issue templates for bug and feature request #16806

MarcoFalke commented at 10:49 AM on September 5, 2019: member

Can be tested via https://github.com/MarcoFalke/bitcoin/issues

MarcoFalke added the label Docs on Sep 5, 2019

laanwj commented at 11:08 AM on September 5, 2019: member

Concept ACK, I like how this provides the help text in comments instead of in-line, making it harder to have it accidentally end up in the issue text itself.

promag commented at 12:14 PM on September 5, 2019: member

Concept ACK.

emilengler commented at 2:47 PM on September 5, 2019: contributor

Concept ACK

in .github/ISSUE_TEMPLATE/bug_report.md:5 in fa07c47b9b outdated

   0 | @@ -0,0 +1,41 @@
   1 | +---
   2 | +name: Bug report
   3 | +about: Create a report to help us improve
   4 | +title: ''
   5 | +labels: bug

ch4ot1c commented at 2:15 AM on September 6, 2019:

Bug in https://github.com/bitcoin/bitcoin/labels

MarcoFalke commented at 12:06 PM on September 6, 2019:

Good catch

in .github/ISSUE_TEMPLATE/bug_report.md:38 in fa07c47b9b outdated

  33 | +
  34 | +<!-- What version of Bitcoin Core are you using, where did you get it (website, self-compiled, etc)? -->
  35 | +
  36 | +<!-- What type of machine are you observing the error on (OS/CPU and disk type)? -->
  37 | +
  38 | +<!-- For the GUI-related issue on Linux provide names and versions of a distro, a desktop environment and a graphical shell (if relevant). -->

ch4ot1c commented at 2:19 AM on September 6, 2019:

GUI-related issue? What is your operation system and its version? If Linux, what is your desktop environment and graphical shell?

MarcoFalke commented at 12:07 PM on September 6, 2019:

Changed

in .github/ISSUE_TEMPLATE/bug_report.md:40 in fa07c47b9b outdated

  35 | +
  36 | +<!-- What type of machine are you observing the error on (OS/CPU and disk type)? -->
  37 | +
  38 | +<!-- For the GUI-related issue on Linux provide names and versions of a distro, a desktop environment and a graphical shell (if relevant). -->
  39 | +
  40 | +<!-- Any extra information that might be useful in the debugging process. -->

ch4ot1c commented at 2:19 AM on September 6, 2019:

. -> ?

MarcoFalke commented at 12:08 PM on September 6, 2019:

I think it is fine as is

ch4ot1c commented at 2:20 AM on September 6, 2019: contributor

ACK; Some suggestions

MarcoFalke force-pushed on Sep 6, 2019

MarcoFalke commented at 12:08 PM on September 6, 2019: member

Addressed feedback by @ch4ot1c

in .github/ISSUE_TEMPLATE.md:23 in faa1231055 outdated

  16 | @@ -17,7 +17,7 @@ If the node is "stuck" during sync or giving "block checksum mismatch" errors, p
  17 |  
  18 |  <!-- What type of machine are you observing the error on (OS/CPU and disk type)? -->
  19 |  
  20 | -<!-- For the GUI-related issue on Linux provide names and versions of a distro, a desktop environment and a graphical shell (if relevant). -->
  21 | +<!-- GUI-related issue? What is your operation system and its version? If Linux, what is your desktop environment and graphical shell? -->
  22 |  
  23 |  <!-- Any extra information that might be useful in the debugging process. -->
  24 |  <!--- This is normally the contents of a `debug.log` or `config.log` file. Raw text or a link to a pastebin type site are preferred. -->

ch4ot1c commented at 6:29 AM on September 8, 2019:

These <!--- could be explained as a leading MD - , but don't look great in the issue preview plaintext and never get rendered as Markdown. Maybe instead add a : e.g. Describe the issue:?

MarcoFalke commented at 1:40 PM on September 8, 2019:

I think it is fine to keep this as it was previously

in .github/ISSUE_TEMPLATE.md:20 in faa1231055 outdated

  16 | @@ -17,7 +17,7 @@ If the node is "stuck" during sync or giving "block checksum mismatch" errors, p
  17 |  
  18 |  <!-- What type of machine are you observing the error on (OS/CPU and disk type)? -->
  19 |  
  20 | -<!-- For the GUI-related issue on Linux provide names and versions of a distro, a desktop environment and a graphical shell (if relevant). -->
  21 | +<!-- GUI-related issue? What is your operation system and its version? If Linux, what is your desktop environment and graphical shell? -->

ch4ot1c commented at 6:29 AM on September 8, 2019:

operating

MarcoFalke commented at 1:41 PM on September 8, 2019:

Fixed typo

ch4ot1c changes_requested

doc: Add issue templates for bug and feature request fabca7756d

MarcoFalke force-pushed on Sep 8, 2019

fanquake approved

fanquake commented at 1:46 PM on September 8, 2019: member

ACK fabca7756d6908ad581f3a699f1be6ecc9f62e03

jb55 commented at 2:36 PM on September 8, 2019: member

ACK fabca7756d6908ad581f3a699f1be6ecc9f62e03

in .github/ISSUE_TEMPLATE/bug_report.md:28 in fabca7756d

  23 | +
  24 | +**Actual behavior**
  25 | +
  26 | +<!--- What was the actual behavior (provide screenshots if the issue is GUI-related)? -->
  27 | +
  28 | +**To reproduce**

jonatack commented at 5:07 PM on September 8, 2019:

Suggest: s/To reproduce/How to reproduce/

MarcoFalke commented at 10:52 AM on September 9, 2019:

This is take from the "official" GitHub template, so I am leaving it for now (unless there is other stuff to fix up)

jonatack commented at 5:08 PM on September 8, 2019: member

Concept ACK

hebasto commented at 10:31 AM on September 9, 2019: member

Concept ACK. Could the legacy .github/ISSUE_TEMPLATE.md be removed at all?

Screenshot from 2019-09-09 13-38-12

MarcoFalke commented at 10:53 AM on September 9, 2019: member

Could the legacy .github/ISSUE_TEMPLATE.md be removed at all?

Why? It doesn't cause any harm and it mentions useful advice for non-bug-reports (e.g. that support requests should go to stackexchange)

MarcoFalke referenced this in commit 5b4e6886e0 on Sep 9, 2019

MarcoFalke merged this on Sep 9, 2019

MarcoFalke closed this on Sep 9, 2019

DrahtBot locked this on Dec 16, 2021