[Doc] Add issue template #8058

pull AmirAbrams wants to merge 1 commits into bitcoin:master from AmirAbrams:docPRT changing 1 files +23 −0
  1. AmirAbrams commented at 7:45 PM on May 15, 2016: contributor

    What is the purpose of this pull request (PR)?

    Adds an issue template.

    Any background context to help the reviewer?

    Issue templates are new to Github and not yet implemented in this repo: Github issue-template

    Example Issue Template:

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

    Describe the issue

    This is an example issue.

    Is the issue reproducible? Yes

    List steps to reproduce below:

    1. Open Qt wallet
    2. Open Menu...
    3. Press test button

    Expected behavior

    This is just an example.

    Actual behavior

    This is just an example.

    Any information in the debug.log file related to this issue?

    Example data: 2016-08-10 05:16:25 keypool added key 135, size=135

    Screenshots (if available)

    N/A

    What binary version was used (official or self compiled)

    official binary version 0.12.

    Machine specs: CPU, RAM, Disk space & OS (Windows, OS X, Linux)

    Linux (Ubuntu) 16.04 64 bit, 2x vCPU, 2 TB disk and 6 GB RAM.

  2. btcdrak commented at 8:57 PM on May 15, 2016: contributor

    We definitely need something like this for issues so people can more accurately report bugs.

  3. AmirAbrams commented at 3:06 AM on May 16, 2016: contributor

    Added an issue template as well.

  4. AmirAbrams renamed this:
    Doc: Adds pull request template [skip ci]
    Doc: Adds pull request & issue template [skip ci]
    on May 16, 2016
  5. AmirAbrams renamed this:
    Doc: Adds pull request & issue template [skip ci]
    [Doc]: Adds pull request & issue template [skip ci]
    on May 16, 2016
  6. AmirAbrams renamed this:
    [Doc]: Adds pull request & issue template [skip ci]
    [Doc] Adds pull request & issue template [skip ci]
    on May 16, 2016
  7. jonasschnelli commented at 7:46 AM on May 16, 2016: contributor

    I think we should add this to https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md (this page is referred to while creating an issue or PR).

  8. jonasschnelli added the label Docs and Output on May 16, 2016
  9. MarcoFalke commented at 8:27 AM on May 16, 2016: member

    @jonasschnelli I am assuming GitHub will auto-fill the body of the pull or issue with this template, so you don't need to refer to it.

  10. in PULL_REQUEST_TEMPLATE.md:None in 8009d4c37f outdated 
       0 | @@ -0,0 +1,11 @@
   1 | +#### What is the purpose of this pull request (PR)?
   2 | +
   3 | +#### Any background context to help the reviewer?
   4 | +
   5 | +#### Was this PR tested and how?
   6 | +
   7 | +#### Does this PR resolve an open issue?
    MarcoFalke commented at 8:28 AM on May 16, 2016:

    We usually put Fixes #---- in the body of the pull to indicate that an open issue is resolved. Not sure if having a section for this in every pull makes sense.

  11. AmirAbrams commented at 4:02 AM on May 20, 2016: contributor

    I will add the Fixes # to the PR template and squash my commits into one.

    Is this something you want to implement (ACK or NACK)?

  12. fanquake commented at 12:34 PM on May 21, 2016: member

    @AmirAbrams It is something worth adding, but make the fixes you've mentioned before asking for ACK/NACKS.

  13. AmirAbrams commented at 6:40 PM on May 21, 2016: contributor

    @fanquake, I made the requested change and squashed my commits into one.

    You can test these templates by adding an issue or PR to my forked Bitcoin repo: https://github.com/amirabrams/bitcoin

    Please let me know if there are any more changes you need to these templates. Thanks!

  14. arowser commented at 8:43 AM on May 25, 2016: contributor

    Can one of the admins verify this patch?

  15. fanquake commented at 8:22 AM on May 27, 2016: member

    PR Template:

    • mention adding [skip-ci] so that trivial/doc only changes don't get run on Travis.
    • You can probably remove the more-questions section
    • Add a note about adding [doc] or [RPC] etc to the title.
    • Screenshots can be added, they are necessary for GUI changes.
    • Could have a what machines/os have you tested/compiled this code?

    Issue Template:

    • What version of bitcoin-core are you using? Official release or self-compiled?
    • Basic specs, such as disk space and available ram.

    Looks like we can also stash these files, as well as contributing.md in a hidden .github dir if we don't want to clutter the repo root.

  16. MarcoFalke commented at 9:07 AM on May 27, 2016: member

    mention adding [skip-ci] so that trivial/doc only changes don't get run on Travis.

    It now has to be somewhere in the commit body instead of just the GitHub pull. Taking into account that travis is now pretty fast due to efficient caching, it may not be worth to mention it in the template.

    In general I am not in favor of adding too much to the pull request template, because stuff that is not relevant has to be deleted every time a pull is created. I may even prefer no pull request template at all.

  17. AmirAbrams commented at 5:59 PM on June 3, 2016: contributor

    @fanquake, I will make your requested changes, move the templates to a hidden .githubdirectory and squash my commits but don't want to waist time if the Bitcoin team does not want to implement these github templates. @MarcoFalke, please let me know how you want to proceed with this PR.

    Thanks!

  18. MarcoFalke commented at 6:21 PM on June 3, 2016: member

    I think having an issue template makes sense to preempt #8130 (comment) et al.

    I am not convinced about the pull template, but I am happy to hear other opinions. (Preferably by people who regularly create pulls)

  19. paveljanik commented at 7:46 PM on June 3, 2016: contributor

    I do not think PR template is needed. But for Issue, it is OK!

  20. fanquake commented at 2:55 AM on August 8, 2016: member

    @AmirAbrams Consensus seems to be to add just an issue template, can you update this pull?

    I'd also suggest adding bitcoin specific sections to the issue template, such as

    • Is the issue reproducible?
    • Binary verrsion and wether it's offical or self compiled.
    • Machine specs: CPU, RAM, Disk space & type etc
    • Debug log
  21. AmirAbrams commented at 4:38 PM on August 10, 2016: contributor

    Yes, I will update the commit with your changes.

  22. AmirAbrams renamed this:
    [Doc] Adds pull request & issue template [skip ci]
    [Doc] Adds issue template [skip ci]
    on Aug 10, 2016
  23. AmirAbrams renamed this:
    [Doc] Adds issue template [skip ci]
    [Doc] Adds issue template
    on Aug 10, 2016
  24. Adds issue template. [skip ci] 3897668f5e
  25. MarcoFalke renamed this:
    [Doc] Adds issue template
    [Doc] Add issue template
    on Aug 12, 2016
  26. MarcoFalke commented at 11:47 AM on August 12, 2016: member

    Nit: Our preference is to use present-tense, imperative-style commit messages. (The default for git)

  27. MarcoFalke commented at 11:47 AM on August 12, 2016: member

    utACK 3897668

  28. laanwj commented at 6:05 AM on August 16, 2016: member

    utACK 3897668

  29. laanwj merged this on Aug 16, 2016
  30. laanwj closed this on Aug 16, 2016
  31. laanwj referenced this in commit bbd9740f53 on Aug 16, 2016
  32. codablock referenced this in commit dbcee85554 on Sep 19, 2017
  33. codablock referenced this in commit 6435e9565e on Dec 29, 2017
  34. codablock referenced this in commit a953997b28 on Jan 8, 2018
  35. andvgal referenced this in commit 40d2c8db34 on Jan 6, 2019
  36. MarcoFalke locked this on Sep 8, 2021
Contributors
AmirAbramsbtcdrakjonasschnelliMarcoFalkefanquakearowserpaveljaniklaanwj
Labels
Docs
github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-04-22 18:15 UTC
This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me