Make ISSUE_TEMPLATE a bit shorter, mention hardware tests #11686
Conversation
.github/ISSUE_TEMPLATE.md
Outdated
| @@ -1,37 +1,23 @@ | |||
| <!--- Remove sections that do not apply --> | |||
|
|
|||
| This issue tracker is only for technical issues related to bitcoin-core. | |||
| This issue tracker is only for technical issues related to Bitcoin Core. | |||
|
|
|||
| General bitcoin questions and/or support requests and are best directed to the [Bitcoin StackExchange](https://bitcoin.stackexchange.com). | |||
TheBlueMatt
force-pushed
the
2017-11-shorter-default-issue
branch
from
56f7600
to
f469294
Compare
TheBlueMatt
force-pushed
the
2017-11-shorter-default-issue
branch
from
f469294
to
ea3f363
Compare
|
re-utACK ea3f363 |
|
While we're changing this anyway, what also might make sense is writing the template in comments ( |
|
ACK ea3f363 |
|
ACK. Agree with adding the comments so that the default text no longer ends up in the issue. |
|
utACK ea3f363 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 |
| @@ -1,37 +1,23 @@ | |||
| <!--- Remove sections that do not apply --> | |||
|
|
|||
| This issue tracker is only for technical issues related to bitcoin-core. | |||
| This issue tracker is only for technical issues related to Bitcoin Core. | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
uh, I guess it's what @laanwj suggests above.
|
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 :/. |
|
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. |
ea3f363 Make ISSUE_TEMPLATE a bit shorter, mention hardware tests (Matt Corallo) Pull request description: 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. Tree-SHA512: 943a286f6ea5c4f837a8dc3906342e1e428cf788d05ba9110f8005400d9775ae6f9cf3ce31ada201f5f7b95a6101314f2cb93f49dd92e242fbcea00aaae9e6e6
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.
I doubt anyone is going to preview template the just to click the links. |
…dware tests Summary: ea3f363 Make ISSUE_TEMPLATE a bit shorter, mention hardware tests (Matt Corallo) Pull request description: 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. --- e89adba Make default issue text all comments to make issues more readable (Matt Corallo) --- Backport of Core [[bitcoin/bitcoin#11686 | PR11686]] and [[bitcoin/bitcoin#11706 | PR11706]] Test Plan: read it Reviewers: #bitcoin_abc, Fabien Reviewed By: #bitcoin_abc, Fabien Subscribers: Fabien Differential Revision: https://reviews.bitcoinabc.org/D8171
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.