Make ISSUE_TEMPLATE a bit shorter, mention hardware tests #11686

pull TheBlueMatt wants to merge 1 commits into bitcoin:master from TheBlueMatt:2017-11-shorter-default-issue changing 1 files +9 −23

TheBlueMatt commented at 5:46 PM on November 14, 2017: member

Kinda getting tired of "block checksum mismatch error" issues on RPis that dont even have heatsinks...Also a shorter issue template might encourage people to actually read it.

in .github/ISSUE_TEMPLATE.md:5 in 56f76007d8 outdated

   0 | @@ -1,37 +1,23 @@
   1 |  <!--- Remove sections that do not apply -->
   2 |  
   3 | -This issue tracker is only for technical issues related to bitcoin-core.
   4 | +This issue tracker is only for technical issues related to Bitcoin Core.
   5 |  
   6 |  General bitcoin questions and/or support requests and are best directed to the [Bitcoin StackExchange](https://bitcoin.stackexchange.com).

MarcoFalke commented at 5:47 PM on November 14, 2017:

s/and are/are/

MarcoFalke approved
TheBlueMatt force-pushed on Nov 14, 2017
Make ISSUE_TEMPLATE a bit shorter, mention hardware tests ea3f363aa0
TheBlueMatt force-pushed on Nov 14, 2017
MarcoFalke commented at 6:00 PM on November 14, 2017: member

re-utACK ea3f363aa0900fe97aeb22b160314272eb4a8067
laanwj commented at 7:10 PM on November 14, 2017: member

While we're changing this anyway, what also might make sense is writing the template in comments (); or at least the explanatory text. It doesn't need to end up in the issue.
practicalswift commented at 9:33 PM on November 14, 2017: contributor

ACK ea3f363aa0900fe97aeb22b160314272eb4a8067
fanquake added the label Docs and Output on Nov 14, 2017
fanquake commented at 11:53 PM on November 14, 2017: member

ACK. Agree with adding the comments so that the default text no longer ends up in the issue.
jonasschnelli commented at 7:21 AM on November 15, 2017: contributor

utACK ea3f363aa0900fe97aeb22b160314272eb4a8067 Also ack for @laanwj idea about commenting out the default text blocks.
meshcollider commented at 9:30 AM on November 15, 2017: contributor

utACK https://github.com/bitcoin/bitcoin/pull/11686/commits/ea3f363aa0900fe97aeb22b160314272eb4a8067

Another +1 for commenting out the all the monologue at the top "This issue tracker is only....before creating an issue!" and the thing about debug.log at the end

in .github/ISSUE_TEMPLATE.md:3 in ea3f363aa0

   0 | @@ -1,37 +1,23 @@
   1 |  <!--- Remove sections that do not apply -->
   2 |  
   3 | -This issue tracker is only for technical issues related to bitcoin-core.
   4 | +This issue tracker is only for technical issues related to Bitcoin Core.

promag commented at 10:14 AM on November 15, 2017:

All of these notes can be inside a comment block:

<!---
Remove sections that do not apply.

This issue tracker is only ...

General bitcoin questions ...

...
--->

So that the user can see it when writing but it won't show.

promag commented at 10:15 AM on November 15, 2017:

uh, I guess it's what @laanwj suggests above.

promag commented at 10:14 AM on November 15, 2017: member

utACK.
TheBlueMatt commented at 10:35 PM on November 15, 2017: member

Heh, I'd be afraid of putting the entire explanatory block into a comment as users are likely to simply answer the questions in-line, and end up with the entire issue in a comment :/.
MarcoFalke commented at 10:42 PM on November 15, 2017: member

There are some links in the text, which won't render in preview when they are commented out. Guess it is fine as is, no need to have a lengthy discussion about it.
MarcoFalke merged this on Nov 15, 2017
MarcoFalke closed this on Nov 15, 2017
MarcoFalke referenced this in commit 54aedc0137 on Nov 15, 2017
laanwj commented at 7:24 AM on November 16, 2017: member

Heh, I'd be afraid of putting the entire explanatory block into a comment as users are likely to simply answer the questions in-line, and end up with the entire issue in a comment :/.

I think that's less likely, at least if commented out per sentence and not entirely. There are many projects doing this anyhow...

Also comments do still end up in the server, so IF this happens someone with editing permissions can fix it up.

There are some links in the text, which won't render in preview when they are commented out. Guess it is fine as is, no need to have a lengthy discussion about it.

I doubt anyone is going to preview template the just to click the links.
TheBlueMatt commented at 4:51 PM on November 16, 2017: member

@laanwj is #11706 closer to what you envision?
jasonbcox referenced this in commit d678fee2af on Oct 29, 2020
DrahtBot locked this on Sep 8, 2021

Contributors

Labels