-
Notifications
You must be signed in to change notification settings - Fork 35.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Doc] Add issue template #8058
[Doc] Add issue template #8058
Conversation
We definitely need something like this for issues so people can more accurately report bugs. |
Added an issue template as well. |
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). |
@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. |
|
||
#### Was this PR tested and how? | ||
|
||
#### Does this PR resolve an open issue? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
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)? |
@AmirAbrams It is something worth adding, but make the fixes you've mentioned before asking for ACK/NACKS. |
@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! |
Can one of the admins verify this patch? |
PR Template:
Issue Template:
Looks like we can also stash these files, as well as contributing.md in a hidden |
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. |
@fanquake, I will make your requested changes, move the templates to a hidden @MarcoFalke, please let me know how you want to proceed with this PR. Thanks! |
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) |
I do not think PR template is needed. But for Issue, it is OK! |
@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
|
Yes, I will update the commit with your changes. |
Nit: Our preference is to use present-tense, imperative-style commit messages. (The default for git) |
utACK 3897668 |
1 similar comment
utACK 3897668 |
3897668 Adds issue template. [skip ci] (CryptoVote)
3897668 Adds issue template. [skip ci] (CryptoVote)
3897668 Adds issue template. [skip ci] (CryptoVote)
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:
Describe the issue
This is an example issue.
Is the issue reproducible? Yes
List steps to reproduce below:
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.