Skip to content
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

Merged
merged 1 commit into from
Aug 16, 2016
Merged

[Doc] Add issue template #8058

merged 1 commit into from
Aug 16, 2016

Conversation

AmirAbrams
Copy link
Contributor

@AmirAbrams AmirAbrams commented May 15, 2016

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:

  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.

@btcdrak
Copy link
Contributor

btcdrak commented May 15, 2016

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

@AmirAbrams
Copy link
Contributor Author

Added an issue template as well.

@AmirAbrams AmirAbrams changed the title Doc: Adds pull request template [skip ci] Doc: Adds pull request & issue template [skip ci] May 16, 2016
@AmirAbrams AmirAbrams changed the title Doc: Adds pull request & issue template [skip ci] [Doc]: Adds pull request & issue template [skip ci] May 16, 2016
@AmirAbrams AmirAbrams changed the title [Doc]: Adds pull request & issue template [skip ci] [Doc] Adds pull request & issue template [skip ci] May 16, 2016
@jonasschnelli
Copy link
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).

@maflcko
Copy link
Member

maflcko commented May 16, 2016

@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?
Copy link
Member

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.

@AmirAbrams
Copy link
Contributor Author

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)?

@fanquake
Copy link
Member

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

@AmirAbrams
Copy link
Contributor Author

AmirAbrams commented May 21, 2016

@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!

@arowser
Copy link
Contributor

arowser commented May 25, 2016

Can one of the admins verify this patch?

@fanquake
Copy link
Member

fanquake commented May 27, 2016

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.

@maflcko
Copy link
Member

maflcko commented May 27, 2016

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.

@AmirAbrams
Copy link
Contributor Author

@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!

@maflcko
Copy link
Member

maflcko commented Jun 3, 2016

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)

@paveljanik
Copy link
Contributor

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

@fanquake
Copy link
Member

fanquake commented Aug 8, 2016

@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

@AmirAbrams
Copy link
Contributor Author

Yes, I will update the commit with your changes.

@AmirAbrams AmirAbrams changed the title [Doc] Adds pull request & issue template [skip ci] [Doc] Adds issue template [skip ci] Aug 10, 2016
@AmirAbrams AmirAbrams changed the title [Doc] Adds issue template [skip ci] [Doc] Adds issue template Aug 10, 2016
@maflcko maflcko changed the title [Doc] Adds issue template [Doc] Add issue template Aug 12, 2016
@maflcko
Copy link
Member

maflcko commented Aug 12, 2016

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

@maflcko
Copy link
Member

maflcko commented Aug 12, 2016

utACK 3897668

1 similar comment
@laanwj
Copy link
Member

laanwj commented Aug 16, 2016

utACK 3897668

@laanwj laanwj merged commit 3897668 into bitcoin:master Aug 16, 2016
laanwj added a commit that referenced this pull request Aug 16, 2016
3897668 Adds issue template. [skip ci] (CryptoVote)
codablock pushed a commit to codablock/dash that referenced this pull request Jan 8, 2018
3897668 Adds issue template. [skip ci] (CryptoVote)
andvgal pushed a commit to energicryptocurrency/gen2-energi that referenced this pull request Jan 6, 2019
3897668 Adds issue template. [skip ci] (CryptoVote)
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Sep 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants